all: regenerate APIs
Change-Id: Ia78859ee0a8265938f59914a99bf3b5904cb2acb
Reviewed-on: https://code-review.googlesource.com/11411
Reviewed-by: Victor Chudnovsky <vchudnov@google.com>
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
index a64dea2..9c182ec 100644
--- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
+++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,22 +1,11 @@
{
- "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://acceleratedmobilepageurl.googleapis.com/",
- "servicePath": "",
- "description": "This API contains a single method, batchGet. Call this method to retrieve the AMP URL (and equivalent AMP Cache URL) for given public URL(s).\n",
- "kind": "discovery#restDescription",
- "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "acceleratedmobilepageurl",
"batchPath": "batch",
"documentationLink": "https://developers.google.com/amp/cache/",
- "revision": "20170224",
"id": "acceleratedmobilepageurl:v1",
+ "revision": "20170224",
"title": "Accelerated Mobile Pages (AMP) URL API",
"ownerName": "Google",
"discoveryVersion": "v1",
@@ -25,52 +14,61 @@
"ampUrls": {
"methods": {
"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"
+ },
"response": {
"$ref": "BatchGetAmpUrlsResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
"parameters": {},
- "flatPath": "v1/ampUrls:batchGet",
- "path": "v1/ampUrls:batchGet",
- "id": "acceleratedmobilepageurl.ampUrls.batchGet",
- "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).",
- "request": {
- "$ref": "BatchGetAmpUrlsRequest"
- }
+ "flatPath": "v1/ampUrls:batchGet"
}
}
}
},
"parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
"location": "query"
},
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -80,9 +78,12 @@
"enum": [
"1",
"2"
- ]
+ ],
+ "description": "V1 error format."
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -94,17 +95,15 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "location": "query"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
@@ -118,20 +117,91 @@
"description": "Pretty-print response.",
"type": "boolean",
"default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
}
},
"schemas": {
+ "AmpUrl": {
+ "description": "AMP URL response for a requested URL.",
+ "type": "object",
+ "properties": {
+ "cdnAmpUrl": {
+ "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
+ "type": "string"
+ },
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
+ },
+ "ampUrl": {
+ "description": "The AMP URL pointing to the publisher's web server.",
+ "type": "string"
+ }
+ },
+ "id": "AmpUrl"
+ },
+ "AmpUrlError": {
+ "description": "AMP URL Error resource for a requested URL that couldn't be found.",
+ "type": "object",
+ "properties": {
+ "errorCode": {
+ "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.",
+ "Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
+ "Indicates no AMP URL has been found that corresponds to the requested\nURL.",
+ "Indicates some kind of application error occurred at the server.\nClient advised to retry.",
+ "DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
+ "Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
+ ]
+ },
+ "originalUrl": {
+ "description": "The original non-AMP URL.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "An optional descriptive error message.",
+ "type": "string"
+ }
+ },
+ "id": "AmpUrlError"
+ },
+ "BatchGetAmpUrlsRequest": {
+ "description": "AMP URL request for a batch of URLs.",
+ "type": "object",
+ "properties": {
+ "lookupStrategy": {
+ "enumDescriptions": [
+ "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.",
+ "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended."
+ ],
+ "enum": [
+ "FETCH_LIVE_DOC",
+ "IN_INDEX_DOC"
+ ],
+ "description": "The lookup_strategy being requested.",
+ "type": "string"
+ },
+ "urls": {
+ "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchGetAmpUrlsRequest"
+ },
"BatchGetAmpUrlsResponse": {
+ "description": "Batch AMP URL response.",
"type": "object",
"properties": {
"ampUrls": {
@@ -149,88 +219,18 @@
}
}
},
- "id": "BatchGetAmpUrlsResponse",
- "description": "Batch AMP URL response."
- },
- "AmpUrl": {
- "type": "object",
- "properties": {
- "cdnAmpUrl": {
- "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.",
- "type": "string"
- },
- "originalUrl": {
- "description": "The original non-AMP URL.",
- "type": "string"
- },
- "ampUrl": {
- "description": "The AMP URL pointing to the publisher's web server.",
- "type": "string"
- }
- },
- "id": "AmpUrl",
- "description": "AMP URL response for a requested URL."
- },
- "AmpUrlError": {
- "description": "AMP URL Error resource for a requested URL that couldn't be found.",
- "type": "object",
- "properties": {
- "errorMessage": {
- "description": "An optional descriptive error message.",
- "type": "string"
- },
- "errorCode": {
- "enumDescriptions": [
- "Not specified error.",
- "Indicates the requested URL is not found in the index, possibly because\nit's unable to be found, not able to be accessed by Googlebot, or some\nother error.",
- "Indicates no AMP URL has been found that corresponds to the requested\nURL.",
- "Indicates some kind of application error occurred at the server.\nClient advised to retry.",
- "DEPRECATED: Indicates the requested URL is a valid AMP URL. This is a\nnon-error state, should not be relied upon as a sign of success or\nfailure. It will be removed in future versions of the API.",
- "Indicates that an AMP URL has been found that corresponds to the request\nURL, but it is not valid AMP HTML."
- ],
- "enum": [
- "ERROR_CODE_UNSPECIFIED",
- "INPUT_URL_NOT_FOUND",
- "NO_AMP_URL",
- "APPLICATION_ERROR",
- "URL_IS_VALID_AMP",
- "URL_IS_INVALID_AMP"
- ],
- "description": "The error code of an API call.",
- "type": "string"
- },
- "originalUrl": {
- "description": "The original non-AMP URL.",
- "type": "string"
- }
- },
- "id": "AmpUrlError"
- },
- "BatchGetAmpUrlsRequest": {
- "description": "AMP URL request for a batch of URLs.",
- "type": "object",
- "properties": {
- "urls": {
- "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "lookupStrategy": {
- "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."
- ]
- }
- },
- "id": "BatchGetAmpUrlsRequest"
+ "id": "BatchGetAmpUrlsResponse"
}
- }
+ },
+ "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://acceleratedmobilepageurl.googleapis.com/",
+ "servicePath": "",
+ "description": "This API contains a single method, batchGet. Call this method to retrieve the AMP URL (and equivalent AMP Cache URL) for given public URL(s).\n",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/"
}
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
index 6a8df73..1932695 100644
--- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
+++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,16 +1,630 @@
{
- "version": "v2beta1",
- "baseUrl": "https://adexchangebuyer.googleapis.com/",
"kind": "discovery#restDescription",
- "servicePath": "",
"description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
+ "servicePath": "",
"basePath": "",
- "revision": "20170302",
+ "revision": "20170308",
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/guides/client-access/",
"id": "adexchangebuyer2:v2beta1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "Image": {
+ "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "Image width in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "url": {
+ "description": "The URL of the image.",
+ "type": "string"
+ },
+ "height": {
+ "description": "Image height in pixels.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Image"
+ },
+ "Reason": {
+ "description": "A specific filtering status and how many times it occurred.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "count": {
+ "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Reason"
+ },
+ "VideoContent": {
+ "properties": {
+ "videoUrl": {
+ "description": "The URL to fetch a video ad.",
+ "type": "string"
+ }
+ },
+ "id": "VideoContent",
+ "description": "Video content for a creative.",
+ "type": "object"
+ },
+ "ClientUserInvitation": {
+ "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "invitationId": {
+ "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
+ "type": "string"
+ },
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ClientUserInvitation"
+ },
+ "AuctionContext": {
+ "description": "@OutputOnly The auction type the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "auctionTypes": {
+ "description": "The auction types this restriction applies to.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "OPEN_AUCTION",
+ "DIRECT_DEALS"
+ ]
+ },
+ "enumDescriptions": [
+ "The restriction applies to open auction.",
+ "The restriction applies to direct deals."
+ ]
+ }
+ },
+ "id": "AuctionContext"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "ClientUserInvitation"
+ },
+ "description": "The returned list of client users."
+ }
+ }
+ },
+ "ListClientUsersResponse": {
+ "type": "object",
+ "properties": {
+ "users": {
+ "type": "array",
+ "items": {
+ "$ref": "ClientUser"
+ },
+ "description": "The returned list of client users."
+ },
+ "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"
+ },
+ "LocationContext": {
+ "type": "object",
+ "properties": {
+ "geoCriteriaIds": {
+ "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "LocationContext",
+ "description": "@OutputOnly The Geo criteria the restriction applies to."
+ },
+ "PlatformContext": {
+ "description": "@OutputOnly The type of platform the restriction applies to.",
+ "type": "object",
+ "properties": {
+ "platforms": {
+ "enumDescriptions": [
+ "Desktop platform.",
+ "Android platform.",
+ "iOS platform."
+ ],
+ "description": "The platforms this restriction applies to.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "DESKTOP",
+ "ANDROID",
+ "IOS"
+ ],
+ "type": "string"
+ }
+ }
+ },
+ "id": "PlatformContext"
+ },
+ "ClientUser": {
+ "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "clientAccountId": {
+ "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the client user.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined user status.",
+ "A user who was already created but hasn't accepted the invitation yet.",
+ "A user that is currently active.",
+ "A user that is currently disabled."
+ ],
+ "enum": [
+ "USER_STATUS_UNSPECIFIED",
+ "PENDING",
+ "ACTIVE",
+ "DISABLED"
+ ]
+ },
+ "userId": {
+ "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
+ "format": "int64",
+ "type": "string"
+ },
+ "email": {
+ "description": "User's email address. The value of this field\nis ignored in an update operation.",
+ "type": "string"
+ }
+ },
+ "id": "ClientUser"
+ },
+ "CreativeDealAssociation": {
+ "description": "The association between a creative and a deal.",
+ "type": "object",
+ "properties": {
+ "dealsId": {
+ "description": "The externalDealId for the deal associated with the creative.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "The account the creative belongs to.",
+ "type": "string"
+ },
+ "creativeId": {
+ "description": "The ID of the creative associated with the deal.",
+ "type": "string"
+ }
+ },
+ "id": "CreativeDealAssociation"
+ },
+ "Creative": {
+ "id": "Creative",
+ "description": "A creative and its classification data.",
+ "type": "object",
+ "properties": {
+ "filteringStats": {
+ "description": "@OutputOnly The filtering stats for this creative.",
+ "$ref": "FilteringStats"
+ },
+ "attributes": {
+ "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "ATTRIBUTE_UNSPECIFIED",
+ "IS_TAGGED",
+ "IS_COOKIE_TARGETED",
+ "IS_USER_INTEREST_TARGETED",
+ "EXPANDING_DIRECTION_NONE",
+ "EXPANDING_DIRECTION_UP",
+ "EXPANDING_DIRECTION_DOWN",
+ "EXPANDING_DIRECTION_LEFT",
+ "EXPANDING_DIRECTION_RIGHT",
+ "EXPANDING_DIRECTION_UP_LEFT",
+ "EXPANDING_DIRECTION_UP_RIGHT",
+ "EXPANDING_DIRECTION_DOWN_LEFT",
+ "EXPANDING_DIRECTION_DOWN_RIGHT",
+ "EXPANDING_DIRECTION_UP_OR_DOWN",
+ "EXPANDING_DIRECTION_LEFT_OR_RIGHT",
+ "EXPANDING_DIRECTION_ANY_DIAGONAL",
+ "EXPANDING_ACTION_ROLLOVER_TO_EXPAND",
+ "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH",
+ "RICH_MEDIA_CAPABILITY_TYPE_MRAID",
+ "RICH_MEDIA_CAPABILITY_TYPE_SSL",
+ "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
+ "NATIVE_ELIGIBILITY_ELIGIBLE",
+ "NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
+ "RENDERING_SIZELESS_ADX"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Do not use. This is a placeholder value only.",
+ "The creative is tagged.",
+ "The creative is cookie targeted.",
+ "The creative is user interest targeted.",
+ "The creative does not expand.",
+ "The creative expands up.",
+ "The creative expands down.",
+ "The creative expands left.",
+ "The creative expands right.",
+ "The creative expands up and left.",
+ "The creative expands up and right.",
+ "The creative expands down and left.",
+ "The creative expands down and right.",
+ "The creative expands up or down.",
+ "The creative expands left or right.",
+ "The creative expands on any diagonal.",
+ "The creative expands when rolled over.",
+ "The instream vast video type is vpaid flash.",
+ "The creative is MRAID",
+ "The creative is SSL.",
+ "The creative is an interstitial.",
+ "The creative is eligible for native.",
+ "The creative is not eligible for native.",
+ "The creative can dynamically resize to fill a variety of slot sizes."
+ ]
+ },
+ "apiUpdateTime": {
+ "description": "@OutputOnly The last update timestamp of the creative via API.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "detectedLanguages": {
+ "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "creativeId": {
+ "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod."
+ },
+ "native": {
+ "$ref": "NativeContent",
+ "description": "A native creative."
+ },
+ "servingRestrictions": {
+ "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
+ "type": "array",
+ "items": {
+ "$ref": "ServingRestriction"
+ }
+ },
+ "video": {
+ "description": "A video creative.",
+ "$ref": "VideoContent"
+ },
+ "agencyId": {
+ "description": "The agency ID for this creative.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clickThroughUrls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The set of destination URLs for the creative."
+ },
+ "adChoicesDestinationUrl": {
+ "description": "The link to AdChoices destination page.",
+ "type": "string"
+ },
+ "detectedSensitiveCategories": {
+ "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "restrictedCategories": {
+ "enumDescriptions": [
+ "The ad has no restricted categories",
+ "The alcohol restricted category."
+ ],
+ "description": "All restricted categories for the ads that may be shown from this creative.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "NO_RESTRICTED_CATEGORIES",
+ "ALCOHOL"
+ ],
+ "type": "string"
+ }
+ },
+ "corrections": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "type": "array",
+ "items": {
+ "$ref": "Correction"
+ }
+ },
+ "version": {
+ "description": "@OutputOnly The version of this creative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "vendorIds": {
+ "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "impressionTrackingUrls": {
+ "description": "The set of URLs to be called to record an impression.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "html": {
+ "description": "An HTML creative.",
+ "$ref": "HtmlContent"
+ },
+ "dealsStatus": {
+ "type": "string",
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ],
+ "description": "@OutputOnly The top-level 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."
+ },
+ "detectedProductCategories": {
+ "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "openAuctionStatus": {
+ "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "string",
+ "enumDescriptions": [
+ "The status is unknown.",
+ "The creative has not been checked.",
+ "The creative has been conditionally approved.\nSee serving_restrictions for details.",
+ "The creative has been approved.",
+ "The creative has been disapproved."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "NOT_CHECKED",
+ "CONDITIONALLY_APPROVED",
+ "APPROVED",
+ "DISAPPROVED"
+ ]
+ },
+ "advertiserName": {
+ "description": "The name of the company being advertised in the creative.",
+ "type": "string"
+ },
+ "detectedDomains": {
+ "description": "@OutputOnly\nThe detected domains for this creative.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "detectedAdvertiserIds": {
+ "description": "@OutputOnly Detected advertiser IDs, if any.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "format": "int64"
+ }
+ }
+ }
+ },
+ "FilteringStats": {
+ "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
+ "type": "object",
+ "properties": {
+ "date": {
+ "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24.",
+ "$ref": "Date"
+ },
+ "reasons": {
+ "description": "The set of filtering reasons for this date.",
+ "type": "array",
+ "items": {
+ "$ref": "Reason"
+ }
+ }
+ },
+ "id": "FilteringStats"
+ },
+ "RemoveDealAssociationRequest": {
+ "id": "RemoveDealAssociationRequest",
+ "description": "A request for removing the association between a deal and a creative.",
+ "type": "object",
+ "properties": {
+ "association": {
+ "$ref": "CreativeDealAssociation",
+ "description": "The association between a creative and a deal that should be removed."
+ }
+ }
+ },
+ "Client": {
+ "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
+ "type": "object",
+ "properties": {
+ "clientName": {
+ "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
+ "type": "string"
+ },
+ "role": {
+ "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client role.",
+ "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
+ "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
+ "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
+ ],
+ "enum": [
+ "CLIENT_ROLE_UNSPECIFIED",
+ "CLIENT_DEAL_VIEWER",
+ "CLIENT_DEAL_NEGOTIATOR",
+ "CLIENT_DEAL_APPROVER"
+ ]
+ },
+ "visibleToSeller": {
+ "description": "Whether the client buyer will be visible to sellers.",
+ "type": "boolean"
+ },
+ "entityId": {
+ "type": "string",
+ "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
+ "format": "int64"
+ },
+ "clientAccountId": {
+ "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
+ "format": "int64",
+ "type": "string"
+ },
+ "entityName": {
+ "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
+ "type": "string"
+ },
+ "status": {
+ "enumDescriptions": [
+ "A placeholder for an undefined client status.",
+ "A client that is currently disabled.",
+ "A client that is currently active."
+ ],
+ "enum": [
+ "CLIENT_STATUS_UNSPECIFIED",
+ "DISABLED",
+ "ACTIVE"
+ ],
+ "description": "The status of the client buyer.",
+ "type": "string"
+ },
+ "entityType": {
+ "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
+ "type": "string",
+ "enumDescriptions": [
+ "A placeholder for an undefined client entity type. Should not be used.",
+ "An advertiser.",
+ "A brand.",
+ "An advertising agency."
+ ],
+ "enum": [
+ "ENTITY_TYPE_UNSPECIFIED",
+ "ADVERTISER",
+ "BRAND",
+ "AGENCY"
+ ]
+ }
+ },
+ "id": "Client"
+ },
+ "Correction": {
+ "description": "@OutputOnly Shows any corrections that were applied to this creative.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enum": [
+ "CORRECTION_TYPE_UNSPECIFIED",
+ "VENDOR_IDS_ADDED",
+ "SSL_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_REMOVED",
+ "FLASH_FREE_ATTRIBUTE_ADDED",
+ "REQUIRED_ATTRIBUTE_ADDED",
+ "REQUIRED_VENDOR_ADDED",
+ "SSL_ATTRIBUTE_ADDED",
+ "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
+ "MRAID_ATTRIBUTE_ADDED",
+ "FLASH_ATTRIBUTE_REMOVED",
+ "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
+ ],
+ "description": "The type of correction that was applied to the creative.",
+ "type": "string",
+ "enumDescriptions": [
+ "The correction type is unknown. Refer to the details for more information.",
+ "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
+ "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
+ "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
+ "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
+ "The ad did not declare a required creative attribute.\nThe attribute was added.",
+ "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
+ "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
+ "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
+ "The ad makes calls to the MRAID API so the MRAID attribute was added.",
+ "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
+ "The ad contains video content."
+ ]
+ },
+ "contexts": {
+ "description": "The contexts for the correction.",
+ "type": "array",
+ "items": {
+ "$ref": "ServingContext"
+ }
+ },
+ "details": {
+ "description": "Additional details about what was corrected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Correction"
+ },
"AddDealAssociationRequest": {
"description": "A request for associating a deal and a creative.",
"type": "object",
@@ -26,20 +640,26 @@
"description": "A response for listing creative and deal associations",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.",
- "type": "string"
- },
"associations": {
"description": "The list of associations.",
"type": "array",
"items": {
"$ref": "CreativeDealAssociation"
}
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results."
}
},
"id": "ListDealAssociationsResponse"
},
+ "StopWatchingCreativeRequest": {
+ "description": "A request for stopping notifications for changes to creative Status.",
+ "type": "object",
+ "properties": {},
+ "id": "StopWatchingCreativeRequest"
+ },
"Disapproval": {
"description": "@OutputOnly The reason and details for a disapproval.",
"type": "object",
@@ -52,6 +672,102 @@
}
},
"reason": {
+ "enum": [
+ "LENGTH_OF_IMAGE_ANIMATION",
+ "BROKEN_URL",
+ "MEDIA_NOT_FUNCTIONAL",
+ "INVALID_FOURTH_PARTY_CALL",
+ "INCORRECT_REMARKETING_DECLARATION",
+ "LANDING_PAGE_ERROR",
+ "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
+ "NO_BORDER",
+ "FOURTH_PARTY_BROWSER_COOKIES",
+ "LSO_OBJECTS",
+ "BLANK_CREATIVE",
+ "DESTINATION_URLS_UNDECLARED",
+ "PROBLEM_WITH_CLICK_MACRO",
+ "INCORRECT_AD_TECHNOLOGY_DECLARATION",
+ "INCORRECT_DESTINATION_URL_DECLARATION",
+ "EXPANDABLE_INCORRECT_DIRECTION",
+ "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
+ "EXPANDABLE_INVALID_VENDOR",
+ "EXPANDABLE_FUNCTIONALITY",
+ "VIDEO_INVALID_VENDOR",
+ "VIDEO_UNSUPPORTED_LENGTH",
+ "VIDEO_UNSUPPORTED_FORMAT",
+ "VIDEO_FUNCTIONALITY",
+ "LANDING_PAGE_DISABLED",
+ "MALWARE_SUSPECTED",
+ "ADULT_IMAGE_OR_VIDEO",
+ "INACCURATE_AD_TEXT",
+ "COUNTERFEIT_DESIGNER_GOODS",
+ "POP_UP",
+ "INVALID_RTB_PROTOCOL_USAGE",
+ "RAW_IP_ADDRESS_IN_SNIPPET",
+ "UNACCEPTABLE_CONTENT_SOFTWARE",
+ "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
+ "UNDECLARED_FLASH_OBJECTS",
+ "INVALID_SSL_DECLARATION",
+ "DIRECT_DOWNLOAD_IN_AD",
+ "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
+ "DESTINATION_URL_SITE_NOT_CRAWLABLE",
+ "BAD_URL_LEGAL_DISAPPROVAL",
+ "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
+ "DYNAMIC_DNS_AT_DESTINATION_URL",
+ "POOR_IMAGE_OR_VIDEO_QUALITY",
+ "UNACCEPTABLE_IMAGE_CONTENT",
+ "INCORRECT_IMAGE_LAYOUT",
+ "IRRELEVANT_IMAGE_OR_VIDEO",
+ "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
+ "MISLEADING_CLAIMS_IN_AD",
+ "RESTRICTED_PRODUCTS",
+ "UNACCEPTABLE_CONTENT",
+ "AUTOMATED_AD_CLICKING",
+ "INVALID_URL_PROTOCOL",
+ "UNDECLARED_RESTRICTED_CONTENT",
+ "INVALID_REMARKETING_LIST_USAGE",
+ "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
+ "CLICK_TO_DOWNLOAD_NOT_AN_APP",
+ "INACCURATE_REVIEW_EXTENSION",
+ "SEXUALLY_EXPLICIT_CONTENT",
+ "GAINING_AN_UNFAIR_ADVANTAGE",
+ "GAMING_THE_GOOGLE_NETWORK",
+ "DANGEROUS_PRODUCTS_KNIVES",
+ "DANGEROUS_PRODUCTS_EXPLOSIVES",
+ "DANGEROUS_PRODUCTS_GUNS",
+ "DANGEROUS_PRODUCTS_DRUGS",
+ "DANGEROUS_PRODUCTS_TOBACCO",
+ "DANGEROUS_PRODUCTS_WEAPONS",
+ "UNCLEAR_OR_IRRELEVANT_AD",
+ "PROFESSIONAL_STANDARDS",
+ "DYSFUNCTIONAL_PROMOTION",
+ "INVALID_INTEREST_BASED_AD",
+ "MISUSE_OF_PERSONAL_INFORMATION",
+ "OMISSION_OF_RELEVANT_INFORMATION",
+ "UNAVAILABLE_PROMOTIONS",
+ "MISLEADING_PROMOTIONS",
+ "INAPPROPRIATE_CONTENT",
+ "SENSITIVE_EVENTS",
+ "SHOCKING_CONTENT",
+ "ENABLING_DISHONEST_BEHAVIOR",
+ "TECHNICAL_REQUIREMENTS",
+ "RESTRICTED_POLITICAL_CONTENT",
+ "UNSUPPORTED_CONTENT",
+ "INVALID_BIDDING_METHOD",
+ "VIDEO_TOO_LONG",
+ "VIOLATES_JAPANESE_PHARMACY_LAW",
+ "UNACCREDITED_PET_PHARMACY",
+ "ABORTION",
+ "CONTRACEPTIVES",
+ "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
+ "KCDSP_REGISTRATION",
+ "NOT_FAMILY_SAFE",
+ "CLINICAL_TRIAL_RECRUITMENT",
+ "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
+ "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
+ "PERSONAL_LOANS",
+ "UNSUPPORTED_FLASH_CONTENT"
+ ],
"description": "The categorized reason for disapproval.",
"type": "string",
"enumDescriptions": [
@@ -149,117 +865,27 @@
"Maximum number of cookies exceeded.",
"Financial service ad does not adhere to specifications.",
"Flash content was found in an unsupported context."
- ],
- "enum": [
- "LENGTH_OF_IMAGE_ANIMATION",
- "BROKEN_URL",
- "MEDIA_NOT_FUNCTIONAL",
- "INVALID_FOURTH_PARTY_CALL",
- "INCORRECT_REMARKETING_DECLARATION",
- "LANDING_PAGE_ERROR",
- "AD_SIZE_DOES_NOT_MATCH_AD_SLOT",
- "NO_BORDER",
- "FOURTH_PARTY_BROWSER_COOKIES",
- "LSO_OBJECTS",
- "BLANK_CREATIVE",
- "DESTINATION_URLS_UNDECLARED",
- "PROBLEM_WITH_CLICK_MACRO",
- "INCORRECT_AD_TECHNOLOGY_DECLARATION",
- "INCORRECT_DESTINATION_URL_DECLARATION",
- "EXPANDABLE_INCORRECT_DIRECTION",
- "EXPANDABLE_DIRECTION_NOT_SUPPORTED",
- "EXPANDABLE_INVALID_VENDOR",
- "EXPANDABLE_FUNCTIONALITY",
- "VIDEO_INVALID_VENDOR",
- "VIDEO_UNSUPPORTED_LENGTH",
- "VIDEO_UNSUPPORTED_FORMAT",
- "VIDEO_FUNCTIONALITY",
- "LANDING_PAGE_DISABLED",
- "MALWARE_SUSPECTED",
- "ADULT_IMAGE_OR_VIDEO",
- "INACCURATE_AD_TEXT",
- "COUNTERFEIT_DESIGNER_GOODS",
- "POP_UP",
- "INVALID_RTB_PROTOCOL_USAGE",
- "RAW_IP_ADDRESS_IN_SNIPPET",
- "UNACCEPTABLE_CONTENT_SOFTWARE",
- "UNAUTHORIZED_COOKIE_ON_GOOGLE_DOMAIN",
- "UNDECLARED_FLASH_OBJECTS",
- "INVALID_SSL_DECLARATION",
- "DIRECT_DOWNLOAD_IN_AD",
- "MAXIMUM_DOWNLOAD_SIZE_EXCEEDED",
- "DESTINATION_URL_SITE_NOT_CRAWLABLE",
- "BAD_URL_LEGAL_DISAPPROVAL",
- "PHARMA_GAMBLING_ALCOHOL_NOT_ALLOWED",
- "DYNAMIC_DNS_AT_DESTINATION_URL",
- "POOR_IMAGE_OR_VIDEO_QUALITY",
- "UNACCEPTABLE_IMAGE_CONTENT",
- "INCORRECT_IMAGE_LAYOUT",
- "IRRELEVANT_IMAGE_OR_VIDEO",
- "DESTINATION_SITE_DOES_NOT_ALLOW_GOING_BACK",
- "MISLEADING_CLAIMS_IN_AD",
- "RESTRICTED_PRODUCTS",
- "UNACCEPTABLE_CONTENT",
- "AUTOMATED_AD_CLICKING",
- "INVALID_URL_PROTOCOL",
- "UNDECLARED_RESTRICTED_CONTENT",
- "INVALID_REMARKETING_LIST_USAGE",
- "DESTINATION_SITE_NOT_CRAWLABLE_ROBOTS_TXT",
- "CLICK_TO_DOWNLOAD_NOT_AN_APP",
- "INACCURATE_REVIEW_EXTENSION",
- "SEXUALLY_EXPLICIT_CONTENT",
- "GAINING_AN_UNFAIR_ADVANTAGE",
- "GAMING_THE_GOOGLE_NETWORK",
- "DANGEROUS_PRODUCTS_KNIVES",
- "DANGEROUS_PRODUCTS_EXPLOSIVES",
- "DANGEROUS_PRODUCTS_GUNS",
- "DANGEROUS_PRODUCTS_DRUGS",
- "DANGEROUS_PRODUCTS_TOBACCO",
- "DANGEROUS_PRODUCTS_WEAPONS",
- "UNCLEAR_OR_IRRELEVANT_AD",
- "PROFESSIONAL_STANDARDS",
- "DYSFUNCTIONAL_PROMOTION",
- "INVALID_INTEREST_BASED_AD",
- "MISUSE_OF_PERSONAL_INFORMATION",
- "OMISSION_OF_RELEVANT_INFORMATION",
- "UNAVAILABLE_PROMOTIONS",
- "MISLEADING_PROMOTIONS",
- "INAPPROPRIATE_CONTENT",
- "SENSITIVE_EVENTS",
- "SHOCKING_CONTENT",
- "ENABLING_DISHONEST_BEHAVIOR",
- "TECHNICAL_REQUIREMENTS",
- "RESTRICTED_POLITICAL_CONTENT",
- "UNSUPPORTED_CONTENT",
- "INVALID_BIDDING_METHOD",
- "VIDEO_TOO_LONG",
- "VIOLATES_JAPANESE_PHARMACY_LAW",
- "UNACCREDITED_PET_PHARMACY",
- "ABORTION",
- "CONTRACEPTIVES",
- "NEED_CERTIFICATES_TO_ADVERTISE_IN_CHINA",
- "KCDSP_REGISTRATION",
- "NOT_FAMILY_SAFE",
- "CLINICAL_TRIAL_RECRUITMENT",
- "MAXIMUM_NUMBER_OF_HTTP_CALLS_EXCEEDED",
- "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED",
- "PERSONAL_LOANS",
- "UNSUPPORTED_FLASH_CONTENT"
]
}
},
"id": "Disapproval"
},
- "StopWatchingCreativeRequest": {
- "description": "A request for stopping notifications for changes to creative Status.",
- "type": "object",
- "properties": {},
- "id": "StopWatchingCreativeRequest"
- },
"ServingRestriction": {
- "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
- "type": "object",
"properties": {
+ "disapprovalReasons": {
+ "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "type": "array",
+ "items": {
+ "$ref": "Disapproval"
+ }
+ },
+ "contexts": {
+ "type": "array",
+ "items": {
+ "$ref": "ServingContext"
+ },
+ "description": "The contexts for the restriction."
+ },
"status": {
"description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).",
"type": "string",
@@ -273,28 +899,22 @@
"DISAPPROVAL",
"PENDING_REVIEW"
]
- },
- "disapprovalReasons": {
- "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "array",
- "items": {
- "$ref": "Disapproval"
- }
- },
- "contexts": {
- "description": "The contexts for the restriction.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
}
},
- "id": "ServingRestriction"
+ "id": "ServingRestriction",
+ "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).",
+ "type": "object"
},
"Date": {
+ "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": {
+ "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",
@@ -304,20 +924,14 @@
"description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
"format": "int32",
"type": "integer"
- },
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
}
- },
- "id": "Date"
+ }
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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 `{}`."
},
"WatchCreativeRequest": {
"description": "A request for watching changes to creative Status.",
@@ -335,83 +949,23 @@
"type": "object",
"properties": {
"appTypes": {
- "enumDescriptions": [
- "Native app context.",
- "Mobile web app context."
- ],
"description": "The app types this restriction applies to.",
"type": "array",
"items": {
+ "type": "string",
"enum": [
"NATIVE",
"WEB"
- ],
- "type": "string"
- }
+ ]
+ },
+ "enumDescriptions": [
+ "Native app context.",
+ "Mobile web app context."
+ ]
}
},
"id": "AppContext"
},
- "NativeContent": {
- "description": "Native content for a creative.",
- "type": "object",
- "properties": {
- "priceDisplayText": {
- "description": "The price of the promoted app including currency info.",
- "type": "string"
- },
- "image": {
- "$ref": "Image",
- "description": "A large image."
- },
- "clickTrackingUrl": {
- "description": "The URL to use for click tracking.",
- "type": "string"
- },
- "advertiserName": {
- "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
- "type": "string"
- },
- "storeUrl": {
- "description": "The URL to the app store to purchase/download the promoted app.",
- "type": "string"
- },
- "headline": {
- "description": "A short title for the ad.",
- "type": "string"
- },
- "appIcon": {
- "description": "The app icon, for app download ads.",
- "$ref": "Image"
- },
- "callToAction": {
- "description": "A label for the button that the user is supposed to click.",
- "type": "string"
- },
- "body": {
- "description": "A long description of the ad.",
- "type": "string"
- },
- "starRating": {
- "description": "The app rating in the app store. Must be in the range [0-5].",
- "format": "double",
- "type": "number"
- },
- "videoUrl": {
- "description": "The URL to fetch a native video ad.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "NativeContent"
- },
"ListClientsResponse": {
"type": "object",
"properties": {
@@ -429,37 +983,110 @@
},
"id": "ListClientsResponse"
},
+ "NativeContent": {
+ "description": "Native content for a creative.",
+ "type": "object",
+ "properties": {
+ "storeUrl": {
+ "description": "The URL to the app store to purchase/download the promoted app.",
+ "type": "string"
+ },
+ "headline": {
+ "description": "A short title for the ad.",
+ "type": "string"
+ },
+ "appIcon": {
+ "$ref": "Image",
+ "description": "The app icon, for app download ads."
+ },
+ "callToAction": {
+ "description": "A label for the button that the user is supposed to click.",
+ "type": "string"
+ },
+ "body": {
+ "description": "A long description of the ad.",
+ "type": "string"
+ },
+ "starRating": {
+ "description": "The app rating in the app store. Must be in the range [0-5].",
+ "format": "double",
+ "type": "number"
+ },
+ "videoUrl": {
+ "description": "The URL to fetch a native video ad.",
+ "type": "string"
+ },
+ "clickLinkUrl": {
+ "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+ "type": "string"
+ },
+ "logo": {
+ "$ref": "Image",
+ "description": "A smaller image, for the advertiser's logo."
+ },
+ "priceDisplayText": {
+ "type": "string",
+ "description": "The price of the promoted app including currency info."
+ },
+ "clickTrackingUrl": {
+ "description": "The URL to use for click tracking.",
+ "type": "string"
+ },
+ "image": {
+ "description": "A large image.",
+ "$ref": "Image"
+ },
+ "advertiserName": {
+ "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.",
+ "type": "string"
+ }
+ },
+ "id": "NativeContent"
+ },
"SecurityContext": {
+ "id": "SecurityContext",
"description": "@OutputOnly A security context.",
"type": "object",
"properties": {
"securities": {
- "description": "The security types in this context.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "INSECURE",
- "SSL"
- ]
- },
"enumDescriptions": [
"Matches impressions that require insecure compatibility.",
"Matches impressions that require SSL compatibility."
- ]
+ ],
+ "description": "The security types in this context.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "INSECURE",
+ "SSL"
+ ],
+ "type": "string"
+ }
+ }
+ }
+ },
+ "ListCreativesResponse": {
+ "description": "A response for listing creatives.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "creatives": {
+ "description": "The list of creatives.",
+ "type": "array",
+ "items": {
+ "$ref": "Creative"
+ }
}
},
- "id": "SecurityContext"
+ "id": "ListCreativesResponse"
},
"HtmlContent": {
"description": "HTML content for a creative.",
"type": "object",
"properties": {
- "height": {
- "description": "The height of the HTML snippet in pixels.",
- "format": "int32",
- "type": "integer"
- },
"width": {
"description": "The width of the HTML snippet in pixels.",
"format": "int32",
@@ -468,686 +1095,57 @@
"snippet": {
"description": "The HTML snippet that displays the ad when inserted in the web page.",
"type": "string"
+ },
+ "height": {
+ "type": "integer",
+ "description": "The height of the HTML snippet in pixels.",
+ "format": "int32"
}
},
"id": "HtmlContent"
},
- "ListCreativesResponse": {
- "description": "A response for listing creatives.",
- "type": "object",
- "properties": {
- "creatives": {
- "description": "The list of creatives.",
- "type": "array",
- "items": {
- "$ref": "Creative"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativesRequest.page_token\nfield in the subsequent call to `ListCreatives` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListCreativesResponse"
- },
"ServingContext": {
"description": "The serving context for this restriction.",
"type": "object",
"properties": {
- "securityType": {
- "$ref": "SecurityContext",
- "description": "Matches impressions for a particular security type."
- },
"platform": {
- "description": "Matches impressions coming from a particular platform.",
- "$ref": "PlatformContext"
+ "$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."
+ "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.",
+ "$ref": "LocationContext"
},
"auctionType": {
- "description": "Matches impressions for a particular auction type.",
- "$ref": "AuctionContext"
+ "$ref": "AuctionContext",
+ "description": "Matches impressions for a particular auction type."
},
"all": {
- "description": "Matches all contexts.",
- "type": "string",
"enumDescriptions": [
"A simple context."
],
"enum": [
"SIMPLE_CONTEXT"
- ]
+ ],
+ "description": "Matches all contexts.",
+ "type": "string"
},
"appType": {
- "description": "Matches impressions for a particular app type.",
- "$ref": "AppContext"
+ "$ref": "AppContext",
+ "description": "Matches impressions for a particular app type."
+ },
+ "securityType": {
+ "$ref": "SecurityContext",
+ "description": "Matches impressions for a particular security type."
}
},
"id": "ServingContext"
- },
- "Image": {
- "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.",
- "type": "object",
- "properties": {
- "height": {
- "description": "Image height in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "width": {
- "description": "Image width in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "url": {
- "description": "The URL of the image.",
- "type": "string"
- }
- },
- "id": "Image"
- },
- "Reason": {
- "description": "A specific filtering status and how many times it occurred.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The filtering status code. Please refer to the\n[creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)\nfile for different statuses.",
- "format": "int32",
- "type": "integer"
- },
- "count": {
- "description": "The number of times the creative was filtered for the status. The\ncount is aggregated across all publishers on the exchange.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Reason"
- },
- "VideoContent": {
- "description": "Video content for a creative.",
- "type": "object",
- "properties": {
- "videoUrl": {
- "description": "The URL to fetch a video ad.",
- "type": "string"
- }
- },
- "id": "VideoContent"
- },
- "ClientUserInvitation": {
- "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.",
- "format": "int64",
- "type": "string"
- },
- "invitationId": {
- "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.",
- "type": "string"
- }
- },
- "id": "ClientUserInvitation"
- },
- "AuctionContext": {
- "description": "@OutputOnly The auction type the restriction applies to.",
- "type": "object",
- "properties": {
- "auctionTypes": {
- "description": "The auction types this restriction applies to.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "OPEN_AUCTION",
- "DIRECT_DEALS"
- ]
- },
- "enumDescriptions": [
- "The restriction applies to open auction.",
- "The restriction applies to direct deals."
- ]
- }
- },
- "id": "AuctionContext"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "ClientUserInvitation"
- }
- }
- },
- "id": "ListClientUserInvitationsResponse"
- },
- "ListClientUsersResponse": {
- "type": "object",
- "properties": {
- "users": {
- "description": "The returned list of client users.",
- "type": "array",
- "items": {
- "$ref": "ClientUser"
- }
- },
- "nextPageToken": {
- "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"
- },
- "LocationContext": {
- "description": "@OutputOnly The Geo criteria the restriction applies to.",
- "type": "object",
- "properties": {
- "geoCriteriaIds": {
- "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "id": "LocationContext"
- },
- "PlatformContext": {
- "description": "@OutputOnly The type of platform the restriction applies to.",
- "type": "object",
- "properties": {
- "platforms": {
- "enumDescriptions": [
- "Desktop platform.",
- "Android platform.",
- "iOS platform."
- ],
- "description": "The platforms this restriction applies to.",
- "type": "array",
- "items": {
- "enum": [
- "DESKTOP",
- "ANDROID",
- "IOS"
- ],
- "type": "string"
- }
- }
- },
- "id": "PlatformContext"
- },
- "ClientUser": {
- "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "status": {
- "description": "The status of the client user.",
- "type": "string",
- "enumDescriptions": [
- "A placeholder for an undefined user status.",
- "A user who was already created but hasn't accepted the invitation yet.",
- "A user that is currently active.",
- "A user that is currently disabled."
- ],
- "enum": [
- "USER_STATUS_UNSPECIFIED",
- "PENDING",
- "ACTIVE",
- "DISABLED"
- ]
- },
- "userId": {
- "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.",
- "format": "int64",
- "type": "string"
- },
- "email": {
- "description": "User's email address. The value of this field\nis ignored in an update operation.",
- "type": "string"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "ClientUser"
- },
- "CreativeDealAssociation": {
- "description": "The association between a creative and a deal.",
- "type": "object",
- "properties": {
- "dealsId": {
- "description": "The externalDealId for the deal associated with the creative.",
- "type": "string"
- },
- "accountId": {
- "description": "The account the creative belongs to.",
- "type": "string"
- },
- "creativeId": {
- "description": "The ID of the creative associated with the deal.",
- "type": "string"
- }
- },
- "id": "CreativeDealAssociation"
- },
- "Creative": {
- "description": "A creative and its classification data.",
- "type": "object",
- "properties": {
- "filteringStats": {
- "$ref": "FilteringStats",
- "description": "@OutputOnly The filtering stats for this creative."
- },
- "attributes": {
- "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "array",
- "items": {
- "enum": [
- "ATTRIBUTE_UNSPECIFIED",
- "IS_TAGGED",
- "IS_COOKIE_TARGETED",
- "IS_USER_INTEREST_TARGETED",
- "EXPANDING_DIRECTION_NONE",
- "EXPANDING_DIRECTION_UP",
- "EXPANDING_DIRECTION_DOWN",
- "EXPANDING_DIRECTION_LEFT",
- "EXPANDING_DIRECTION_RIGHT",
- "EXPANDING_DIRECTION_UP_LEFT",
- "EXPANDING_DIRECTION_UP_RIGHT",
- "EXPANDING_DIRECTION_DOWN_LEFT",
- "EXPANDING_DIRECTION_DOWN_RIGHT",
- "EXPANDING_DIRECTION_UP_OR_DOWN",
- "EXPANDING_DIRECTION_LEFT_OR_RIGHT",
- "EXPANDING_DIRECTION_ANY_DIAGONAL",
- "EXPANDING_ACTION_ROLLOVER_TO_EXPAND",
- "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH",
- "RICH_MEDIA_CAPABILITY_TYPE_MRAID",
- "RICH_MEDIA_CAPABILITY_TYPE_SSL",
- "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL",
- "NATIVE_ELIGIBILITY_ELIGIBLE",
- "NATIVE_ELIGIBILITY_NOT_ELIGIBLE",
- "RENDERING_SIZELESS_ADX"
- ],
- "type": "string"
- },
- "enumDescriptions": [
- "Do not use. This is a placeholder value only.",
- "The creative is tagged.",
- "The creative is cookie targeted.",
- "The creative is user interest targeted.",
- "The creative does not expand.",
- "The creative expands up.",
- "The creative expands down.",
- "The creative expands left.",
- "The creative expands right.",
- "The creative expands up and left.",
- "The creative expands up and right.",
- "The creative expands down and left.",
- "The creative expands down and right.",
- "The creative expands up or down.",
- "The creative expands left or right.",
- "The creative expands on any diagonal.",
- "The creative expands when rolled over.",
- "The instream vast video type is vpaid flash.",
- "The creative is MRAID",
- "The creative is SSL.",
- "The creative is an interstitial.",
- "The creative is eligible for native.",
- "The creative is not eligible for native.",
- "The creative can dynamically resize to fill a variety of slot sizes."
- ]
- },
- "apiUpdateTime": {
- "description": "@OutputOnly The last update timestamp of the creative via API.",
- "format": "google-datetime",
- "type": "string"
- },
- "detectedLanguages": {
- "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "creativeId": {
- "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
- },
- "accountId": {
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string"
- },
- "native": {
- "$ref": "NativeContent",
- "description": "A native creative."
- },
- "servingRestrictions": {
- "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).",
- "type": "array",
- "items": {
- "$ref": "ServingRestriction"
- }
- },
- "video": {
- "description": "A video creative.",
- "$ref": "VideoContent"
- },
- "agencyId": {
- "description": "The agency ID for this creative.",
- "format": "int64",
- "type": "string"
- },
- "clickThroughUrls": {
- "description": "The set of destination URLs for the creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "detectedSensitiveCategories": {
- "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "adChoicesDestinationUrl": {
- "description": "The link to AdChoices destination page.",
- "type": "string"
- },
- "restrictedCategories": {
- "enumDescriptions": [
- "The ad has no restricted categories",
- "The alcohol restricted category."
- ],
- "description": "All restricted categories for the ads that may be shown from this creative.",
- "type": "array",
- "items": {
- "enum": [
- "NO_RESTRICTED_CATEGORIES",
- "ALCOHOL"
- ],
- "type": "string"
- }
- },
- "corrections": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "array",
- "items": {
- "$ref": "Correction"
- }
- },
- "version": {
- "description": "@OutputOnly The version of this creative.",
- "format": "int32",
- "type": "integer"
- },
- "vendorIds": {
- "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "impressionTrackingUrls": {
- "description": "The set of URLs to be called to record an impression.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "html": {
- "$ref": "HtmlContent",
- "description": "An HTML creative."
- },
- "dealsStatus": {
- "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ]
- },
- "detectedProductCategories": {
- "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
- },
- "openAuctionStatus": {
- "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "type": "string",
- "enumDescriptions": [
- "The status is unknown.",
- "The creative has not been checked.",
- "The creative has been conditionally approved.\nSee serving_restrictions for details.",
- "The creative has been approved.",
- "The creative has been disapproved."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "NOT_CHECKED",
- "CONDITIONALLY_APPROVED",
- "APPROVED",
- "DISAPPROVED"
- ]
- },
- "advertiserName": {
- "description": "The name of the company being advertised in the creative.",
- "type": "string"
- },
- "detectedAdvertiserIds": {
- "description": "@OutputOnly Detected advertiser IDs, if any.",
- "type": "array",
- "items": {
- "format": "int64",
- "type": "string"
- }
- },
- "detectedDomains": {
- "description": "@OutputOnly\nThe detected domains for this creative.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Creative"
- },
- "FilteringStats": {
- "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).",
- "type": "object",
- "properties": {
- "reasons": {
- "description": "The set of filtering reasons for this date.",
- "type": "array",
- "items": {
- "$ref": "Reason"
- }
- },
- "date": {
- "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24.",
- "$ref": "Date"
- }
- },
- "id": "FilteringStats"
- },
- "RemoveDealAssociationRequest": {
- "description": "A request for removing the association between a deal and a creative.",
- "type": "object",
- "properties": {
- "association": {
- "$ref": "CreativeDealAssociation",
- "description": "The association between a creative and a deal that should be removed."
- }
- },
- "id": "RemoveDealAssociationRequest"
- },
- "Client": {
- "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.",
- "type": "object",
- "properties": {
- "entityType": {
- "enumDescriptions": [
- "A placeholder for an undefined client entity type. Should not be used.",
- "An advertiser.",
- "A brand.",
- "An advertising agency."
- ],
- "enum": [
- "ENTITY_TYPE_UNSPECIFIED",
- "ADVERTISER",
- "BRAND",
- "AGENCY"
- ],
- "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.",
- "type": "string"
- },
- "clientName": {
- "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.",
- "type": "string"
- },
- "role": {
- "enumDescriptions": [
- "A placeholder for an undefined client role.",
- "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.",
- "Users associated with this client can respond to deal proposals\nsent to them by publishers. They can also initiate deal proposals\nof their own.",
- "Users associated with this client can approve eligible deals\non your behalf. Some deals may still explicitly require publisher\nfinalization. If this role is not selected, the sponsor buyer\nwill need to manually approve each of their deals."
- ],
- "enum": [
- "CLIENT_ROLE_UNSPECIFIED",
- "CLIENT_DEAL_VIEWER",
- "CLIENT_DEAL_NEGOTIATOR",
- "CLIENT_DEAL_APPROVER"
- ],
- "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.",
- "type": "string"
- },
- "visibleToSeller": {
- "description": "Whether the client buyer will be visible to sellers.",
- "type": "boolean"
- },
- "entityId": {
- "description": "Numerical identifier of the client entity.\nThe entity can be an advertiser, a brand, or an agency.\nThis identifier is unique among all the entities with the same type.\n\nA list of all known advertisers with their identifiers is available in the\n[advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)\nfile.\n\nA list of all known brands with their identifiers is available in the\n[brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)\nfile.\n\nA list of all known agencies with their identifiers is available in the\n[agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)\nfile.",
- "format": "int64",
- "type": "string"
- },
- "clientAccountId": {
- "description": "The globally-unique numerical ID of the client.\nThe value of this field is ignored in create and update operations.",
- "format": "int64",
- "type": "string"
- },
- "entityName": {
- "description": "The name of the entity. This field is automatically fetched based on\nthe type and ID.\nThe value of this field is ignored in create and update operations.",
- "type": "string"
- },
- "status": {
- "enumDescriptions": [
- "A placeholder for an undefined client status.",
- "A client that is currently disabled.",
- "A client that is currently active."
- ],
- "enum": [
- "CLIENT_STATUS_UNSPECIFIED",
- "DISABLED",
- "ACTIVE"
- ],
- "description": "The status of the client buyer.",
- "type": "string"
- }
- },
- "id": "Client"
- },
- "Correction": {
- "description": "@OutputOnly Shows any corrections that were applied to this creative.",
- "type": "object",
- "properties": {
- "details": {
- "description": "Additional details about what was corrected.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "description": "The type of correction that was applied to the creative.",
- "type": "string",
- "enumDescriptions": [
- "The correction type is unknown. Refer to the details for more information.",
- "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.",
- "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.",
- "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.",
- "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.",
- "The ad did not declare a required creative attribute.\nThe attribute was added.",
- "The ad did not declare a required technology vendor.\nThe technology vendor was added.",
- "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.",
- "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.",
- "The ad makes calls to the MRAID API so the MRAID attribute was added.",
- "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.",
- "The ad contains video content."
- ],
- "enum": [
- "CORRECTION_TYPE_UNSPECIFIED",
- "VENDOR_IDS_ADDED",
- "SSL_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_REMOVED",
- "FLASH_FREE_ATTRIBUTE_ADDED",
- "REQUIRED_ATTRIBUTE_ADDED",
- "REQUIRED_VENDOR_ADDED",
- "SSL_ATTRIBUTE_ADDED",
- "IN_BANNER_VIDEO_ATTRIBUTE_ADDED",
- "MRAID_ATTRIBUTE_ADDED",
- "FLASH_ATTRIBUTE_REMOVED",
- "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED"
- ]
- },
- "contexts": {
- "description": "The contexts for the correction.",
- "type": "array",
- "items": {
- "$ref": "ServingContext"
- }
- }
- },
- "id": "Correction"
}
},
"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": "AdExchangeBuyerII",
"auth": {
@@ -1171,25 +1169,22 @@
"clients": {
"methods": {
"get": {
- "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.",
+ "response": {
+ "$ref": "Client"
+ },
"httpMethod": "GET",
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "response": {
- "$ref": "Client"
- },
"parameters": {
"accountId": {
- "location": "path",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"clientAccountId": {
"location": "path",
@@ -1201,25 +1196,24 @@
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
+ "id": "adexchangebuyer2.accounts.clients.get"
},
"list": {
- "description": "Lists all the clients for the current sponsor buyer.",
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
"response": {
"$ref": "ListClientsResponse"
},
- "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\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"accountId": {
"location": "path",
@@ -1229,17 +1223,25 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.list",
"path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.list"
+ "description": "Lists all the clients for the current sponsor buyer."
},
"update": {
+ "description": "Updates an existing client buyer.",
+ "request": {
+ "$ref": "Client"
+ },
"response": {
"$ref": "Client"
},
@@ -1248,6 +1250,9 @@
"clientAccountId"
],
"httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
"accountId": {
"description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)",
@@ -1264,22 +1269,17 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
- "id": "adexchangebuyer2.accounts.clients.update",
- "request": {
- "$ref": "Client"
- },
- "description": "Updates an existing client buyer."
+ "id": "adexchangebuyer2.accounts.clients.update"
},
"create": {
+ "path": "v2beta1/accounts/{accountId}/clients",
+ "id": "adexchangebuyer2.accounts.clients.create",
+ "description": "Creates a new client buyer.",
"request": {
"$ref": "Client"
},
- "description": "Creates a new client buyer.",
"response": {
"$ref": "Client"
},
@@ -1287,30 +1287,25 @@
"accountId"
],
"httpMethod": "POST",
- "parameters": {
- "accountId": {
- "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/clients",
- "path": "v2beta1/accounts/{accountId}/clients",
- "id": "adexchangebuyer2.accounts.clients.create"
+ "parameters": {
+ "accountId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)",
+ "format": "int64"
+ }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients"
}
},
"resources": {
"users": {
"methods": {
"list": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
- "id": "adexchangebuyer2.accounts.clients.users.list",
"description": "Lists all the known client users for a specified\nsponsor buyer account ID.",
"response": {
"$ref": "ListClientUsersResponse"
@@ -1324,46 +1319,56 @@
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
+ "type": "string"
+ },
"accountId": {
+ "location": "path",
"description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)",
"format": "int64",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"clientAccountId": {
"description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.",
"required": true,
"type": "string",
"location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.",
- "type": "string"
}
- }
+ },
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
+ "id": "adexchangebuyer2.accounts.clients.users.list"
},
"get": {
- "response": {
- "$ref": "ClientUser"
- },
+ "id": "adexchangebuyer2.accounts.clients.users.get",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
+ "description": "Retrieves an existing client user.",
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "response": {
+ "$ref": "ClientUser"
+ },
"parameters": {
+ "userId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64"
+ },
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
@@ -1372,24 +1377,17 @@
"location": "path"
},
"clientAccountId": {
+ "location": "path",
"description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)",
"format": "int64",
"required": true,
- "type": "string",
- "location": "path"
- },
- "userId": {
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
- "id": "adexchangebuyer2.accounts.clients.users.get",
- "description": "Retrieves an existing client user."
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}"
},
"update": {
"request": {
@@ -1407,18 +1405,18 @@
"httpMethod": "PUT",
"parameters": {
"userId": {
- "description": "Numerical identifier of the user to retrieve. (required)",
- "format": "int64",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Numerical identifier of the user to retrieve. (required)",
+ "format": "int64"
},
"accountId": {
+ "location": "path",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"clientAccountId": {
"location": "path",
@@ -1440,66 +1438,71 @@
"invitations": {
"methods": {
"get": {
- "response": {
- "$ref": "ClientUserInvitation"
- },
"parameterOrder": [
"accountId",
"clientAccountId",
"invitationId"
],
"httpMethod": "GET",
- "parameters": {
- "accountId": {
- "location": "path",
- "description": "Numerical account ID of the client's sponsor buyer. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- },
- "clientAccountId": {
- "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "invitationId": {
- "location": "path",
- "description": "Numerical identifier of the user invitation to retrieve. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
- }
+ "response": {
+ "$ref": "ClientUserInvitation"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
+ "parameters": {
+ "accountId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Numerical account ID of the client's sponsor buyer. (required)",
+ "format": "int64"
+ },
+ "clientAccountId": {
+ "location": "path",
+ "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string"
+ },
+ "invitationId": {
+ "description": "Numerical identifier of the user invitation to retrieve. (required)",
+ "format": "int64",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"id": "adexchangebuyer2.accounts.clients.invitations.get",
"description": "Retrieves an existing client user invitation."
},
"list": {
- "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.list",
"description": "Lists all the client users invitations for a client\nwith a given account ID.",
"response": {
"$ref": "ListClientUserInvitationsResponse"
},
+ "httpMethod": "GET",
"parameterOrder": [
"accountId",
"clientAccountId"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
+ "type": "string",
+ "location": "query"
+ },
"accountId": {
- "location": "path",
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"pageSize": {
"location": "query",
@@ -1508,40 +1511,17 @@
"type": "integer"
},
"clientAccountId": {
+ "location": "path",
"description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.",
"required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ]
- },
- "create": {
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
- "id": "adexchangebuyer2.accounts.clients.invitations.create",
- "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.",
- "request": {
- "$ref": "ClientUserInvitation"
- },
- "response": {
- "$ref": "ClientUserInvitation"
- },
- "parameterOrder": [
- "accountId",
- "clientAccountId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
+ "id": "adexchangebuyer2.accounts.clients.invitations.list"
+ },
+ "create": {
"parameters": {
"accountId": {
"location": "path",
@@ -1551,12 +1531,30 @@
"type": "string"
},
"clientAccountId": {
+ "required": true,
+ "type": "string",
"location": "path",
"description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)",
- "format": "int64",
- "required": true,
- "type": "string"
+ "format": "int64"
}
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "id": "adexchangebuyer2.accounts.clients.invitations.create",
+ "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
+ "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"
}
}
}
@@ -1566,40 +1564,37 @@
"creatives": {
"methods": {
"get": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "id": "adexchangebuyer2.accounts.creatives.get",
- "description": "Gets a creative.",
- "response": {
- "$ref": "Creative"
- },
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "httpMethod": "GET",
"parameters": {
"accountId": {
+ "location": "path",
"description": "The account the creative belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"creativeId": {
+ "location": "path",
"description": "The ID of the creative to retrieve.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
- ]
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "id": "adexchangebuyer2.accounts.creatives.get",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
+ "description": "Gets a creative.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "response": {
+ "$ref": "Creative"
+ }
},
"watch": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
- "id": "adexchangebuyer2.accounts.creatives.watch",
"request": {
"$ref": "WatchCreativeRequest"
},
@@ -1613,32 +1608,42 @@
],
"httpMethod": "POST",
"parameters": {
- "accountId": {
- "location": "path",
- "description": "The account of the creative to watch.",
- "required": true,
- "type": "string"
- },
"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.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The account of the creative to watch.",
+ "required": true,
+ "type": "string"
}
},
"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": {
- "response": {
+ "description": "Updates a creative.",
+ "request": {
"$ref": "Creative"
},
+ "httpMethod": "PUT",
"parameterOrder": [
"accountId",
"creativeId"
],
- "httpMethod": "PUT",
+ "response": {
+ "$ref": "Creative"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"parameters": {
"accountId": {
"location": "path",
@@ -1647,33 +1652,38 @@
"type": "string"
},
"creativeId": {
- "location": "path",
"description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"id": "adexchangebuyer2.accounts.creatives.update",
- "request": {
- "$ref": "Creative"
- },
- "description": "Updates a creative."
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}"
},
"list": {
+ "id": "adexchangebuyer2.accounts.creatives.list",
+ "path": "v2beta1/accounts/{accountId}/creatives",
"description": "Lists creatives.",
- "response": {
- "$ref": "ListCreativesResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"accountId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCreativesResponse"
+ },
"parameters": {
+ "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 DisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
+ "type": "string"
+ },
+ "pageToken": {
+ "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",
+ "location": "query"
+ },
"accountId": {
"description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.",
"required": true,
@@ -1681,37 +1691,22 @@
"location": "path"
},
"pageSize": {
+ "location": "query",
"description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.",
"format": "int32",
- "type": "integer",
- "location": "query"
- },
- "query": {
- "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from DisapprovalReason\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.",
- "type": "string"
+ "type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.list"
+ "flatPath": "v2beta1/accounts/{accountId}/creatives"
},
"create": {
- "flatPath": "v2beta1/accounts/{accountId}/creatives",
- "id": "adexchangebuyer2.accounts.creatives.create",
- "path": "v2beta1/accounts/{accountId}/creatives",
- "description": "Creates a creative.",
"request": {
"$ref": "Creative"
},
+ "description": "Creates a creative.",
"httpMethod": "POST",
"parameterOrder": [
"accountId"
@@ -1719,49 +1714,51 @@
"response": {
"$ref": "Creative"
},
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
- "accountId": {
- "location": "path",
- "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
- "required": true,
- "type": "string"
- },
"duplicateIdMode": {
+ "type": "string",
"location": "query",
"enum": [
"NO_DUPLICATES",
"FORCE_ENABLE_DUPLICATE_IDS"
],
- "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).",
+ "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative)."
+ },
+ "accountId": {
+ "location": "path",
+ "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.",
+ "required": true,
"type": "string"
}
- }
- },
- "stopWatching": {
- "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
- "request": {
- "$ref": "StopWatchingCreativeRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "accountId",
- "creativeId"
- ],
- "response": {
- "$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives",
+ "id": "adexchangebuyer2.accounts.creatives.create",
+ "path": "v2beta1/accounts/{accountId}/creatives"
+ },
+ "stopWatching": {
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
+ "id": "adexchangebuyer2.accounts.creatives.stopWatching",
+ "request": {
+ "$ref": "StopWatchingCreativeRequest"
+ },
+ "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "accountId",
+ "creativeId"
+ ],
+ "httpMethod": "POST",
"parameters": {
"accountId": {
+ "location": "path",
"description": "The account of the creative to stop notifications for.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"creativeId": {
"location": "path",
@@ -1770,16 +1767,21 @@
"type": "string"
}
},
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
- "id": "adexchangebuyer2.accounts.creatives.stopWatching",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching"
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching"
}
},
"resources": {
"dealAssociations": {
"methods": {
"list": {
+ "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
+ "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
"description": "List all creative-deal associations.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListDealAssociationsResponse"
},
@@ -1787,24 +1789,26 @@
"accountId",
"creativeId"
],
- "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\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"accountId": {
+ "location": "path",
"description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageSize": {
- "location": "query",
"description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"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'",
@@ -1812,58 +1816,48 @@
"location": "query"
},
"creativeId": {
- "location": "path",
"description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
- "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list"
+ }
},
"add": {
- "description": "Associate an existing deal with a creative.",
- "request": {
- "$ref": "AddDealAssociationRequest"
- },
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"accountId",
"creativeId"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
],
"parameters": {
"accountId": {
- "location": "path",
- "description": "The account the creative belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "The account the creative belongs to."
},
"creativeId": {
- "location": "path",
"description": "The ID of the creative associated with the deal.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add"
+ "description": "Associate an existing deal with a creative.",
+ "request": {
+ "$ref": "AddDealAssociationRequest"
+ }
},
"remove": {
- "description": "Remove the association between a deal and a creative.",
- "request": {
- "$ref": "RemoveDealAssociationRequest"
- },
"response": {
"$ref": "Empty"
},
@@ -1872,9 +1866,6 @@
"creativeId"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/adexchange.buyer"
- ],
"parameters": {
"accountId": {
"description": "The account the creative belongs to.",
@@ -1883,15 +1874,22 @@
"location": "path"
},
"creativeId": {
- "location": "path",
"description": "The ID of the creative associated with the deal.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/adexchange.buyer"
+ ],
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
- "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove"
+ "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
+ "request": {
+ "$ref": "RemoveDealAssociationRequest"
+ },
+ "description": "Remove the association between a deal and a creative."
}
}
}
@@ -1901,62 +1899,73 @@
}
},
"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": {
+ "type": "boolean",
+ "default": "true",
"location": "query",
- "description": "Pretty-print response.",
+ "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": {
+ "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"
},
- "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": {
+ "fields": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "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"
+ ]
+ },
+ "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": [
@@ -1964,28 +1973,19 @@
"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"
+ "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.",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
}
- }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://adexchangebuyer.googleapis.com/"
}
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json
index 6353572..a53770e 100644
--- a/analyticsreporting/v4/analyticsreporting-api.json
+++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,135 +1,34 @@
{
- "ownerName": "Google",
- "resources": {
- "reports": {
- "methods": {
- "batchGet": {
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/analytics",
- "https://www.googleapis.com/auth/analytics.readonly"
- ],
- "flatPath": "v4/reports:batchGet",
- "id": "analyticsreporting.reports.batchGet",
- "path": "v4/reports:batchGet",
- "request": {
- "$ref": "GetReportsRequest"
- },
- "description": "Returns the Analytics data.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "GetReportsResponse"
- }
- }
- }
- }
- },
- "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"
- },
- "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": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- }
- },
- "version": "v4",
- "baseUrl": "https://analyticsreporting.googleapis.com/",
- "servicePath": "",
- "description": "Accesses Analytics report data.",
- "kind": "discovery#restDescription",
"basePath": "",
"id": "analyticsreporting:v4",
"documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/",
- "revision": "20170213",
+ "revision": "20170309",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "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": {
+ "startDate": {
+ "description": "The start date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
+ },
+ "endDate": {
+ "description": "The end date for the query in the format `YYYY-MM-DD`.",
+ "type": "string"
+ }
+ }
+ },
"MetricFilter": {
- "id": "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"
@@ -139,8 +38,6 @@
"type": "string"
},
"operator": {
- "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
- "type": "string",
"enumDescriptions": [
"If the operator is not specified, it is treated as `EQUAL`.",
"Should the value of the metric be exactly equal to the comparison value.",
@@ -154,53 +51,45 @@
"LESS_THAN",
"GREATER_THAN",
"IS_MISSING"
- ]
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\nmetric values will be excluded in the report. The default is false.",
- "type": "boolean"
+ ],
+ "description": "Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the\ncomparisonValue, the default is `EQUAL`. If the operator is\n`IS_MISSING`, checks if the metric is missing and would ignore the\ncomparisonValue.",
+ "type": "string"
}
- }
+ },
+ "id": "MetricFilter"
},
"ReportRequest": {
"description": "The main request class which specifies the Reporting API request.",
"type": "object",
"properties": {
- "dimensions": {
- "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
- "type": "array",
- "items": {
- "$ref": "Dimension"
- }
+ "pageToken": {
+ "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.",
+ "type": "string"
},
"dateRanges": {
- "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.",
"type": "array",
"items": {
"$ref": "DateRange"
- }
- },
- "pageToken": {
- "type": "string",
- "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."
+ },
+ "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition."
},
"pivots": {
+ "description": "The pivot definitions. Requests can have a maximum of 2 pivots.",
"type": "array",
"items": {
"$ref": "Pivot"
- },
- "description": "The pivot definitions. Requests can have a maximum of 2 pivots."
+ }
},
"includeEmptyRows": {
"description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.",
"type": "boolean"
},
"metricFilterClauses": {
+ "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.",
"type": "array",
"items": {
"$ref": "MetricFilterClause"
- },
- "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated."
+ }
},
"pageSize": {
"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.",
@@ -220,8 +109,8 @@
"type": "string"
},
"cohortGroup": {
- "$ref": "CohortGroup",
- "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition."
+ "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"
},
"viewId": {
"description": "The Analytics\n[view ID](https://support.google.com/analytics/answer/1009618)\nfrom which to retrieve data. Every [ReportRequest](#ReportRequest)\nwithin a `batchGet` method must contain the same `viewId`.",
@@ -242,11 +131,11 @@
}
},
"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.",
"type": "array",
"items": {
"$ref": "OrderBy"
- }
+ },
+ "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."
},
"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.",
@@ -256,6 +145,7 @@
}
},
"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.",
@@ -268,13 +158,20 @@
"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."
+ ]
+ },
+ "dimensions": {
+ "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.",
+ "type": "array",
+ "items": {
+ "$ref": "Dimension"
+ }
}
},
"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": {
@@ -290,8 +187,26 @@
"description": "Name of the dimension to fetch, for example `ga:browser`.",
"type": "string"
}
- },
- "id": "Dimension"
+ }
+ },
+ "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": {
+ "sessionSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "Session Segment to select sessions to include in the segment."
+ },
+ "name": {
+ "description": "The name of the dynamic segment.",
+ "type": "string"
+ },
+ "userSegment": {
+ "$ref": "SegmentDefinition",
+ "description": "User Segment to select users to include in the segment."
+ }
+ }
},
"SimpleSegment": {
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.",
@@ -307,32 +222,14 @@
},
"id": "SimpleSegment"
},
- "DynamicSegment": {
- "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.",
- "type": "object",
- "properties": {
- "sessionSegment": {
- "description": "Session Segment to select sessions to include in the segment.",
- "$ref": "SegmentDefinition"
- },
- "name": {
- "type": "string",
- "description": "The name of the dynamic segment."
- },
- "userSegment": {
- "description": "User Segment to select users to include in the segment.",
- "$ref": "SegmentDefinition"
- }
- },
- "id": "DynamicSegment"
- },
"ColumnHeader": {
+ "id": "ColumnHeader",
"description": "Column headers.",
"type": "object",
"properties": {
"metricHeader": {
- "$ref": "MetricHeader",
- "description": "Metric headers for the metrics in the response."
+ "description": "Metric headers for the metrics in the response.",
+ "$ref": "MetricHeader"
},
"dimensions": {
"description": "The dimension names in the response.",
@@ -341,27 +238,26 @@
"type": "string"
}
}
- },
- "id": "ColumnHeader"
+ }
},
"SegmentFilterClause": {
- "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
- "type": "object",
"properties": {
- "metricFilter": {
- "description": "Metric Filter for the segment definition.",
- "$ref": "SegmentMetricFilter"
- },
"not": {
"description": "Matches the complement (`!`) of the filter.",
"type": "boolean"
},
"dimensionFilter": {
- "$ref": "SegmentDimensionFilter",
- "description": "Dimension Filter for the segment definition."
+ "description": "Dimension Filter for the segment definition.",
+ "$ref": "SegmentDimensionFilter"
+ },
+ "metricFilter": {
+ "description": "Metric Filter for the segment definition.",
+ "$ref": "SegmentMetricFilter"
}
},
- "id": "SegmentFilterClause"
+ "id": "SegmentFilterClause",
+ "description": "Filter Clause to be used in a segment definition, can be wither a metric or\na dimension filter.",
+ "type": "object"
},
"MetricFilterClause": {
"description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.",
@@ -392,31 +288,31 @@
"id": "MetricFilterClause"
},
"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": {
+ "name": {
+ "type": "string",
+ "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...]."
+ },
+ "dateRange": {
+ "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.",
+ "$ref": "DateRange"
+ },
"type": {
+ "enum": [
+ "UNSPECIFIED_COHORT_TYPE",
+ "FIRST_VISIT_DATE"
+ ],
"description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.",
"type": "string",
"enumDescriptions": [
"If unspecified it's treated as `FIRST_VISIT_DATE`.",
"Cohorts that are selected based on first visit date."
- ],
- "enum": [
- "UNSPECIFIED_COHORT_TYPE",
- "FIRST_VISIT_DATE"
]
- },
- "name": {
- "description": "A unique name for the cohort. If not defined name will be auto-generated\nwith values cohort_[1234...].",
- "type": "string"
- },
- "dateRange": {
- "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.",
- "$ref": "DateRange"
}
- }
+ },
+ "id": "Cohort"
},
"ReportRow": {
"properties": {
@@ -444,30 +340,30 @@
"type": "object",
"properties": {
"segmentFilterClauses": {
+ "description": "List of segment filters to be combined with a `OR` operator.",
"type": "array",
"items": {
"$ref": "SegmentFilterClause"
- },
- "description": "List of segment filters to be combined with a `OR` operator."
+ }
}
},
"id": "OrFiltersForSegment"
},
"MetricHeader": {
"properties": {
- "metricHeaderEntries": {
- "description": "Headers for the metrics in the response.",
- "type": "array",
- "items": {
- "$ref": "MetricHeaderEntry"
- }
- },
"pivotHeaders": {
"description": "Headers for the pivots in the response.",
"type": "array",
"items": {
"$ref": "PivotHeader"
}
+ },
+ "metricHeaderEntries": {
+ "description": "Headers for the metrics in the response.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricHeaderEntry"
+ }
}
},
"id": "MetricHeader",
@@ -479,8 +375,6 @@
"type": "object",
"properties": {
"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.",
@@ -490,7 +384,9 @@
"OPERATOR_UNSPECIFIED",
"OR",
"AND"
- ]
+ ],
+ "description": "The operator for combining multiple dimension filters. If unspecified, it\nis treated as an `OR`.",
+ "type": "string"
},
"filters": {
"description": "The repeated set of filters. They are logically combined based on the\noperator specified.",
@@ -503,7 +399,6 @@
"id": "DimensionFilterClause"
},
"GetReportsResponse": {
- "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.",
"type": "object",
"properties": {
"reports": {
@@ -514,9 +409,12 @@
}
}
},
- "id": "GetReportsResponse"
+ "id": "GetReportsResponse",
+ "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call."
},
"SequenceSegment": {
+ "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
+ "type": "object",
"properties": {
"firstStepShouldMatchFirstHit": {
"description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).",
@@ -530,22 +428,21 @@
}
}
},
- "id": "SequenceSegment",
- "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.",
- "type": "object"
+ "id": "SequenceSegment"
},
"SegmentMetricFilter": {
"description": "Metric filter to be used in a segment filter clause.",
"type": "object",
"properties": {
+ "maxComparisonValue": {
+ "description": "Max comparison value is only used for `BETWEEN` operator.",
+ "type": "string"
+ },
+ "comparisonValue": {
+ "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
+ "type": "string"
+ },
"operator": {
- "enumDescriptions": [
- "Unspecified operator is treated as `LESS_THAN` operator.",
- "Checks if the metric value is less than comparison value.",
- "Checks if the metric value is greater than comparison value.",
- "Equals operator.",
- "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
- ],
"enum": [
"UNSPECIFIED_OPERATOR",
"LESS_THAN",
@@ -554,7 +451,14 @@
"BETWEEN"
],
"description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operator is treated as `LESS_THAN` operator.",
+ "Checks if the metric value is less than comparison value.",
+ "Checks if the metric value is greater than comparison value.",
+ "Equals operator.",
+ "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison."
+ ]
},
"metricName": {
"description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.",
@@ -577,19 +481,12 @@
"Session scope.",
"User scope."
]
- },
- "maxComparisonValue": {
- "description": "Max comparison value is only used for `BETWEEN` operator.",
- "type": "string"
- },
- "comparisonValue": {
- "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.",
- "type": "string"
}
},
"id": "SegmentMetricFilter"
},
"DateRangeValues": {
+ "id": "DateRangeValues",
"description": "Used to return a list of metrics for a single DateRange / dimension\ncombination",
"type": "object",
"properties": {
@@ -607,28 +504,28 @@
"$ref": "PivotValueRegion"
}
}
- },
- "id": "DateRangeValues"
+ }
},
"CohortGroup": {
"description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }",
"type": "object",
"properties": {
- "lifetimeValue": {
- "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
- "type": "boolean"
- },
"cohorts": {
+ "description": "The definition for the cohort.",
"type": "array",
"items": {
"$ref": "Cohort"
- },
- "description": "The definition for the cohort."
+ }
+ },
+ "lifetimeValue": {
+ "description": "Enable Life Time Value (LTV). LTV measures lifetime value for users\nacquired through different channels.\nPlease see:\n[Cohort Analysis](https://support.google.com/analytics/answer/6074676) and\n[Lifetime Value](https://support.google.com/analytics/answer/6182550)\nIf the value of lifetimeValue is false:\n\n- The metric values are similar to the values in the web interface cohort\n report.\n- The cohort definition date ranges must be aligned to the calendar week\n and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in\n the cohort definition should be a Sunday and the `endDate` should be the\n following Saturday, and for `ga:cohortNthMonth`, the `startDate`\n should be the 1st of the month and `endDate` should be the last day\n of the month.\n\nWhen the lifetimeValue is true:\n\n- The metric values will correspond to the values in the web interface\n LifeTime value report.\n- The Lifetime Value report shows you how user value (Revenue) and\n engagement (Appviews, Goal Completions, Sessions, and Session Duration)\n grow during the 90 days after a user is acquired.\n- The metrics are calculated as a cumulative average per user per the time\n increment.\n- The cohort definition date ranges need not be aligned to the calendar\n week and month boundaries.\n- The `viewId` must be an\n [app view ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews)",
+ "type": "boolean"
}
},
"id": "CohortGroup"
},
"GetReportsRequest": {
+ "id": "GetReportsRequest",
"description": "The batch request containing multiple report request.",
"type": "object",
"properties": {
@@ -639,11 +536,17 @@
"$ref": "ReportRequest"
}
}
- },
- "id": "GetReportsRequest"
+ }
},
"Pivot": {
+ "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.",
+ "type": "object",
"properties": {
+ "startGroup": {
+ "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
+ "format": "int32",
+ "type": "integer"
+ },
"metrics": {
"description": "The pivot metrics. Pivot metrics are part of the\nrestriction on total number of metrics allowed in the request.",
"type": "array",
@@ -652,38 +555,36 @@
}
},
"dimensions": {
+ "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request.",
"type": "array",
"items": {
"$ref": "Dimension"
- },
- "description": "A list of dimensions to show as pivot columns. A Pivot can have a maximum\nof 4 dimensions. Pivot dimensions are part of the restriction on the\ntotal number of dimensions allowed in the request."
+ }
},
"dimensionFilterClauses": {
+ "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns.",
"type": "array",
"items": {
"$ref": "DimensionFilterClause"
- },
- "description": "DimensionFilterClauses are logically combined with an `AND` operator: only\ndata that is included by all these DimensionFilterClauses contributes to\nthe values in this pivot region. Dimension filters can be used to restrict\nthe columns shown in the pivot region. For example if you have\n`ga:browser` as the requested dimension in the pivot region, and you\nspecify key filters to restrict `ga:browser` to only \"IE\" or \"Firefox\",\nthen only those two browsers would show up as columns."
+ }
},
"maxGroupCount": {
"description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.",
"format": "int32",
"type": "integer"
- },
- "startGroup": {
- "type": "integer",
- "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.",
- "format": "int32"
}
},
- "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"
+ "id": "Pivot"
},
"PivotHeaderEntry": {
- "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
- "type": "object",
"properties": {
+ "dimensionValues": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The values for the dimensions in the pivot."
+ },
"dimensionNames": {
"description": "The name of the dimensions in the pivot response.",
"type": "array",
@@ -692,27 +593,18 @@
}
},
"metric": {
- "$ref": "MetricHeaderEntry",
- "description": "The metric header for the metric in the pivot."
- },
- "dimensionValues": {
- "description": "The values for the dimensions in the pivot.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "description": "The metric header for the metric in the pivot.",
+ "$ref": "MetricHeaderEntry"
}
},
- "id": "PivotHeaderEntry"
+ "id": "PivotHeaderEntry",
+ "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.",
+ "type": "object"
},
"SegmentFilter": {
"description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.",
"type": "object",
"properties": {
- "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"
- },
"not": {
"description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },",
"type": "boolean"
@@ -720,6 +612,10 @@
"simpleSegment": {
"$ref": "SimpleSegment",
"description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined"
+ },
+ "sequenceSegment": {
+ "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.",
+ "$ref": "SequenceSegment"
}
},
"id": "SegmentFilter"
@@ -742,6 +638,10 @@
"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",
@@ -761,15 +661,14 @@
"PERCENT",
"TIME"
]
- },
- "name": {
- "description": "The name of the header.",
- "type": "string"
}
},
"id": "MetricHeaderEntry"
},
"ReportData": {
+ "id": "ReportData",
+ "description": "The data part of the report.",
+ "type": "object",
"properties": {
"isDataGolden": {
"description": "Indicates if response to this request is golden or not. Data is\ngolden when the exact same request will not produce any new results if\nasked at a later point in time.",
@@ -829,15 +728,23 @@
"type": "string"
}
}
- },
- "id": "ReportData",
- "description": "The data part of the report.",
- "type": "object"
+ }
},
"DimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
+ "not": {
+ "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false.",
+ "type": "boolean"
+ },
+ "expressions": {
+ "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"caseSensitive": {
"description": "Should the match be case sensitive? Default is false.",
"type": "boolean"
@@ -847,6 +754,7 @@
"type": "string"
},
"operator": {
+ "description": "How to match the dimension to the expression. The default is REGEXP.",
"type": "string",
"enumDescriptions": [
"If the match type is unspecified, it is treated as a `REGEXP`.",
@@ -871,36 +779,92 @@
"NUMERIC_GREATER_THAN",
"NUMERIC_LESS_THAN",
"IN_LIST"
- ],
- "description": "How to match the dimension to the expression. The default is REGEXP."
- },
- "not": {
- "description": "Logical `NOT` operator. If this boolean is set to true, then the matching\ndimension values will be excluded in the report. The default is false.",
- "type": "boolean"
- },
- "expressions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Strings or regular expression to match against. Only the first value of\nthe list is used for comparison unless the operator is `IN_LIST`.\nIf `IN_LIST` operator, then the entire list is used to filter the\ndimensions as explained in the description of the `IN_LIST` operator."
+ ]
}
},
"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": {
+ "dynamicSegment": {
+ "$ref": "DynamicSegment",
+ "description": "A dynamic segment definition in the request."
+ },
+ "segmentId": {
+ "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
+ "type": "string"
+ }
+ },
+ "id": "Segment"
+ },
+ "OrderBy": {
+ "description": "Specifies the sorting options.",
+ "type": "object",
+ "properties": {
+ "fieldName": {
+ "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
+ "type": "string"
+ },
+ "orderType": {
+ "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"
+ ],
+ "description": "The order type. The default orderType is `VALUE`."
+ },
+ "sortOrder": {
+ "enumDescriptions": [
+ "If the sort order is unspecified, the default is ascending.",
+ "Ascending sort. The field will be sorted in an ascending manner.",
+ "Descending sort. The field will be sorted in a descending manner."
+ ],
+ "enum": [
+ "SORT_ORDER_UNSPECIFIED",
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "description": "The sorting order for the field.",
+ "type": "string"
+ }
+ },
+ "id": "OrderBy"
+ },
"SegmentDimensionFilter": {
"description": "Dimension filter specifies the filtering options on a dimension.",
"type": "object",
"properties": {
- "maxComparisonValue": {
- "description": "Maximum comparison values for `BETWEEN` match type.",
- "type": "string"
- },
"dimensionName": {
"description": "Name of the dimension for which the filter is being applied.",
"type": "string"
},
"operator": {
+ "enumDescriptions": [
+ "If the match type is unspecified, it is treated as a REGEXP.",
+ "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
+ "Matches the values which begin with the match expression provided.",
+ "Matches the values which end with the match expression provided.",
+ "Substring match.",
+ "The value should match the match expression entirely.",
+ "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
+ "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
+ "Checks if the dimension is numerically greater than the match\nexpression.",
+ "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
+ ],
"enum": [
"OPERATOR_UNSPECIFIED",
"REGEXP",
@@ -914,19 +878,7 @@
"NUMERIC_BETWEEN"
],
"description": "The operator to use to match the dimension with the expressions.",
- "type": "string",
- "enumDescriptions": [
- "If the match type is unspecified, it is treated as a REGEXP.",
- "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.",
- "Matches the values which begin with the match expression provided.",
- "Matches the values which end with the match expression provided.",
- "Substring match.",
- "The value should match the match expression entirely.",
- "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.",
- "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.",
- "Checks if the dimension is numerically greater than the match\nexpression.",
- "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded."
- ]
+ "type": "string"
},
"expressions": {
"description": "The list of expressions, only the first element is used for all operators",
@@ -940,72 +892,16 @@
"description": "Should the match be case sensitive, ignored for `IN_LIST` operator."
},
"minComparisonValue": {
- "type": "string",
- "description": "Minimum comparison values for `BETWEEN` match type."
+ "description": "Minimum comparison values for `BETWEEN` match type.",
+ "type": "string"
+ },
+ "maxComparisonValue": {
+ "description": "Maximum comparison values for `BETWEEN` match type.",
+ "type": "string"
}
},
"id": "SegmentDimensionFilter"
},
- "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"
- ]
- },
- "fieldName": {
- "description": "The field which to sort by. The default sort order is ascending. Example:\n`ga:browser`.\nNote, that you can only specify one field for sort here. For example,\n`ga:browser, ga:city` is not valid.",
- "type": "string"
- },
- "orderType": {
- "enum": [
- "ORDER_TYPE_UNSPECIFIED",
- "VALUE",
- "DELTA",
- "SMART",
- "HISTOGRAM_BUCKET",
- "DIMENSION_AS_INTEGER"
- ],
- "description": "The order type. The default orderType is `VALUE`.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified order type will be treated as sort based on value.",
- "The sort order is based on the value of the chosen column; looks only at\nthe first date range.",
- "The sort order is based on the difference of the values of the chosen\ncolumn between the first two date ranges. Usable only if there are\nexactly two date ranges.",
- "The sort order is based on weighted value of the chosen column. If\ncolumn has n/d format, then weighted value of this ratio will\nbe `(n + totals.n)/(d + totals.d)` Usable only for metrics that\nrepresent ratios.",
- "Histogram order type is applicable only to dimension columns with\nnon-empty histogram-buckets.",
- "If the dimensions are fixed length numbers, ordinary sort would just\nwork fine. `DIMENSION_AS_INTEGER` can be used if the dimensions are\nvariable length numbers."
- ]
- }
- },
- "id": "OrderBy"
- },
- "Segment": {
- "type": "object",
- "properties": {
- "dynamicSegment": {
- "description": "A dynamic segment definition in the request.",
- "$ref": "DynamicSegment"
- },
- "segmentId": {
- "description": "The segment ID of a built-in or custom segment, for example `gaid::-3`.",
- "type": "string"
- }
- },
- "id": "Segment",
- "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."
- },
"SegmentSequenceStep": {
"properties": {
"orFiltersForSegment": {
@@ -1016,6 +912,7 @@
}
},
"matchType": {
+ "type": "string",
"enumDescriptions": [
"Unspecified match type is treated as precedes.",
"Operator indicates that the previous step precedes the next step.",
@@ -1026,8 +923,7 @@
"PRECEDES",
"IMMEDIATELY_PRECEDES"
],
- "description": "Specifies if the step immediately precedes or can be any time before the\nnext step.",
- "type": "string"
+ "description": "Specifies if the step immediately precedes or can be any time before the\nnext step."
}
},
"id": "SegmentSequenceStep",
@@ -1035,10 +931,17 @@
"type": "object"
},
"Metric": {
- "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.",
"type": "object",
"properties": {
"formattingType": {
+ "enumDescriptions": [
+ "Metric type is unspecified.",
+ "Integer metric.",
+ "Float metric.",
+ "Currency metric.",
+ "Percentage metric.",
+ "Time metric in `HH:MM:SS` format."
+ ],
"enum": [
"METRIC_TYPE_UNSPECIFIED",
"INTEGER",
@@ -1048,28 +951,22 @@
"TIME"
],
"description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.",
- "type": "string",
- "enumDescriptions": [
- "Metric type is unspecified.",
- "Integer metric.",
- "Float metric.",
- "Currency metric.",
- "Percentage metric.",
- "Time metric in `HH:MM:SS` format."
- ]
+ "type": "string"
},
"alias": {
- "type": "string",
- "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."
+ "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": {
- "type": "string",
- "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results."
+ "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.",
+ "type": "string"
}
},
- "id": "Metric"
+ "id": "Metric",
+ "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period."
},
"PivotValueRegion": {
+ "type": "object",
"properties": {
"values": {
"description": "The values of the metrics in each of the pivot regions.",
@@ -1080,17 +977,15 @@
}
},
"id": "PivotValueRegion",
- "description": "The metric values in the pivot region.",
- "type": "object"
+ "description": "The metric values in the pivot region."
},
"Report": {
- "id": "Report",
"description": "The data response corresponding to the request.",
"type": "object",
"properties": {
"columnHeader": {
- "description": "The column headers.",
- "$ref": "ColumnHeader"
+ "$ref": "ColumnHeader",
+ "description": "The column headers."
},
"data": {
"description": "Response data.",
@@ -1100,17 +995,19 @@
"description": "Page token to retrieve the next page of results in the list.",
"type": "string"
}
- }
+ },
+ "id": "Report"
},
"PivotHeader": {
+ "description": "The headers for each of the pivot sections defined in the request.",
"type": "object",
"properties": {
"pivotHeaderEntries": {
+ "description": "A single pivot section header.",
"type": "array",
"items": {
"$ref": "PivotHeaderEntry"
- },
- "description": "A single pivot section header."
+ }
},
"totalPivotGroupsCount": {
"description": "The total number of groups for this pivot.",
@@ -1118,23 +1015,7 @@
"type": "integer"
}
},
- "id": "PivotHeader",
- "description": "The headers for each of the pivot sections defined in the request."
- },
- "DateRange": {
- "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.",
- "type": "object",
- "properties": {
- "startDate": {
- "description": "The start date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- },
- "endDate": {
- "description": "The end date for the query in the format `YYYY-MM-DD`.",
- "type": "string"
- }
- },
- "id": "DateRange"
+ "id": "PivotHeader"
}
},
"protocol": "rest",
@@ -1146,11 +1027,11 @@
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/analytics": {
- "description": "View and manage your Google Analytics data"
- },
"https://www.googleapis.com/auth/analytics.readonly": {
"description": "View your Google Analytics data"
+ },
+ "https://www.googleapis.com/auth/analytics": {
+ "description": "View and manage your Google Analytics data"
}
}
}
@@ -1159,5 +1040,124 @@
"ownerDomain": "google.com",
"name": "analyticsreporting",
"batchPath": "batch",
- "title": "Google Analytics Reporting API"
+ "title": "Google Analytics Reporting API",
+ "ownerName": "Google",
+ "resources": {
+ "reports": {
+ "methods": {
+ "batchGet": {
+ "response": {
+ "$ref": "GetReportsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/analytics",
+ "https://www.googleapis.com/auth/analytics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v4/reports:batchGet",
+ "path": "v4/reports:batchGet",
+ "id": "analyticsreporting.reports.batchGet",
+ "description": "Returns the Analytics data.",
+ "request": {
+ "$ref": "GetReportsRequest"
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://analyticsreporting.googleapis.com/",
+ "servicePath": "",
+ "description": "Accesses Analytics report data.",
+ "kind": "discovery#restDescription"
}
diff --git a/api-list.json b/api-list.json
index d3446c2..598848b 100644
--- a/api-list.json
+++ b/api-list.json
@@ -504,6 +504,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "cloudbilling:v1",
+ "name": "cloudbilling",
+ "version": "v1",
+ "title": "Google Cloud Billing API",
+ "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.",
+ "discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/billing/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "cloudbuild:v1",
"name": "cloudbuild",
"version": "v1",
@@ -549,6 +564,36 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "cloudfunctions:v1beta2",
+ "name": "cloudfunctions",
+ "version": "v1beta2",
+ "title": "Google Cloud Functions API",
+ "description": "API for managing lightweight user-provided functions executed in response to events.",
+ "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v1beta2",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/functions",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
+ "id": "cloudkms:v1",
+ "name": "cloudkms",
+ "version": "v1",
+ "title": "Google Cloud Key Management Service (KMS) API",
+ "description": "Manages encryption for your cloud services the same way you do on-premise. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "discoveryRestUrl": "https://cloudkms.googleapis.com/$discovery/rest?version=v1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/kms/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "cloudkms:v1beta1",
"name": "cloudkms",
"version": "v1beta1",
@@ -560,7 +605,7 @@
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://cloud.google.com/kms/",
- "preferred": true
+ "preferred": false
},
{
"kind": "discovery#directoryItem",
@@ -1365,21 +1410,6 @@
},
{
"kind": "discovery#directoryItem",
- "id": "cloudbilling:v1",
- "name": "cloudbilling",
- "version": "v1",
- "title": "Google Cloud Billing API",
- "description": "Retrieves Google Developers Console billing accounts and associates them with projects.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/cloudbilling/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/billing/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
"id": "container:v1",
"name": "container",
"version": "v1",
@@ -1395,66 +1425,6 @@
},
{
"kind": "discovery#directoryItem",
- "id": "partners:v2",
- "name": "partners",
- "version": "v2",
- "title": "Google Partners API",
- "description": "Lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/partners/v2/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/partners/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "playmoviespartner:v1",
- "name": "playmoviespartner",
- "version": "v1",
- "title": "Google Play Movies Partner API",
- "description": "Gets the delivery status of titles for Google Play Movies Partners.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/playmoviespartner/v1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/playmoviespartner/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "proximitybeacon:v1beta1",
- "name": "proximitybeacon",
- "version": "v1beta1",
- "title": "Google Proximity Beacon API",
- "description": "Registers, manages, indexes, and searches beacons.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/proximitybeacon/v1beta1/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
- "id": "safebrowsing:v4",
- "name": "safebrowsing",
- "version": "v4",
- "title": "Safe Browsing APIs",
- "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
- "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/safebrowsing/v4/rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/safe-browsing/",
- "preferred": true
- },
- {
- "kind": "discovery#directoryItem",
"id": "storagetransfer:v1",
"name": "storagetransfer",
"version": "v1",
@@ -1626,6 +1596,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "ml:v1",
+ "name": "ml",
+ "version": "v1",
+ "title": "Google Cloud Machine Learning Engine",
+ "description": "An API to enable creating and using machine learning models.",
+ "discoveryRestUrl": "https://ml.googleapis.com/$discovery/rest?version=v1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://cloud.google.com/ml/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "ml:v1beta1",
"name": "ml",
"version": "v1beta1",
@@ -1637,7 +1622,7 @@
"x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
},
"documentationLink": "https://cloud.google.com/ml/",
- "preferred": true
+ "preferred": false
},
{
"kind": "discovery#directoryItem",
@@ -1720,6 +1705,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "partners:v2",
+ "name": "partners",
+ "version": "v2",
+ "title": "Google Partners API",
+ "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "discoveryRestUrl": "https://partners.googleapis.com/$discovery/rest?version=v2",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://developers.google.com/partners/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "people:v1",
"name": "people",
"version": "v1",
@@ -1735,6 +1735,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "playmoviespartner:v1",
+ "name": "playmoviespartner",
+ "version": "v1",
+ "title": "Google Play Movies Partner API",
+ "description": "Gets the delivery status of titles for Google Play Movies Partners.",
+ "discoveryRestUrl": "https://playmoviespartner.googleapis.com/$discovery/rest?version=v1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://developers.google.com/playmoviespartner/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "plus:v1",
"name": "plus",
"version": "v1",
@@ -1847,6 +1862,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "proximitybeacon:v1beta1",
+ "name": "proximitybeacon",
+ "version": "v1beta1",
+ "title": "Google Proximity Beacon API",
+ "description": "Registers, manages, indexes, and searches beacons.",
+ "discoveryRestUrl": "https://proximitybeacon.googleapis.com/$discovery/rest?version=v1beta1",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "pubsub:v1beta1a",
"name": "pubsub",
"version": "v1beta1a",
@@ -2052,6 +2082,21 @@
},
{
"kind": "discovery#directoryItem",
+ "id": "safebrowsing:v4",
+ "name": "safebrowsing",
+ "version": "v4",
+ "title": "Google Safe Browsing API",
+ "description": "The Safe Browsing API is an experimental API that allows client applications to check URLs against Google's constantly-updated blacklists of suspected phishing and malware pages. Your client application can use the API to download an encrypted table for local, client-side lookups of URLs.",
+ "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v4",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "documentationLink": "https://developers.google.com/safe-browsing/",
+ "preferred": true
+ },
+ {
+ "kind": "discovery#directoryItem",
"id": "script:v1",
"name": "script",
"version": "v1",
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json
index 89e921b..adbd3c9 100644
--- a/appengine/v1alpha/appengine-api.json
+++ b/appengine/v1alpha/appengine-api.json
@@ -1,305 +1,22 @@
{
- "version": "v1alpha",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Provisions and manages App Engine applications.",
- "kind": "discovery#restDescription",
"rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
+ "revision": "20170302",
"id": "appengine:v1alpha",
"documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
- "revision": "20170221",
"title": "Google App Engine Admin API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"apps": {
- "methods": {
- "get": {
- "description": "Gets information about an application.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Application"
- },
- "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": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}",
- "id": "appengine.apps.get",
- "path": "v1alpha/apps/{appsId}"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "type": "string",
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1alpha/apps/{appsId}",
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
- "request": {
- "$ref": "Application"
- }
- },
- "create": {
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "request": {
- "$ref": "Application"
- },
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1alpha/apps",
- "path": "v1alpha/apps",
- "id": "appengine.apps.create"
- },
- "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",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}:repair",
- "path": "v1alpha/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"
- }
- }
- },
"resources": {
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. The name of the operation collection."
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/operations",
- "path": "v1alpha/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "operationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "path": "v1alpha/apps/{appsId}/operations/{operationsId}",
- "id": "appengine.apps.operations.get"
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "id": "appengine.apps.locations.list",
- "path": "v1alpha/apps/{appsId}/locations",
- "description": "Lists information about the supported locations for this service.",
- "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": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "appsId": {
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/locations"
- },
- "get": {
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get"
- }
- }
- },
"services": {
"methods": {
"delete": {
+ "httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
@@ -307,42 +24,37 @@
"appsId",
"servicesId"
],
- "httpMethod": "DELETE",
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}",
- "path": "v1alpha/apps/{appsId}/services/{servicesId}",
"id": "appengine.apps.services.delete",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}",
"description": "Deletes the specified service and all enclosed versions."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId"
- ],
+ "description": "Lists all the services in the application.",
"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"
+ "parameterOrder": [
+ "appsId"
],
+ "httpMethod": "GET",
"parameters": {
"appsId": {
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
@@ -351,45 +63,45 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "Maximum results to return per page.",
"format": "int32",
- "type": "integer"
+ "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}/services",
- "id": "appengine.apps.services.list",
"path": "v1alpha/apps/{appsId}/services",
- "description": "Lists all the services in the application."
+ "id": "appengine.apps.services.list"
},
"get": {
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}",
- "path": "v1alpha/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.get",
- "description": "Gets the current configuration of the specified service.",
- "response": {
- "$ref": "Service"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"appsId",
"servicesId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "Service"
+ },
"parameters": {
- "servicesId": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
+ "location": "path"
},
- "appsId": {
+ "servicesId": {
"location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
}
@@ -398,38 +110,43 @@
"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}/services/{servicesId}",
+ "id": "appengine.apps.services.get",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}",
+ "description": "Gets the current configuration of the specified service."
},
"patch": {
- "httpMethod": "PATCH",
+ "request": {
+ "$ref": "Service"
+ },
+ "description": "Updates the configuration of the specified service.",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "PATCH",
"parameters": {
"updateMask": {
+ "location": "query",
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
"type": "string"
},
- "appsId": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default."
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
},
"migrateTraffic": {
"description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/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).",
@@ -437,13 +154,12 @@
"location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
"path": "v1alpha/apps/{appsId}/services/{servicesId}",
- "description": "Updates the configuration of the specified service.",
- "request": {
- "$ref": "Service"
- }
+ "id": "appengine.apps.services.patch"
}
},
"resources": {
@@ -464,23 +180,23 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "versionsId": {
+ "servicesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string"
},
- "servicesId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
"appsId": {
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
@@ -489,6 +205,7 @@
},
"list": {
"description": "Lists the versions of a service.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListVersionsResponse"
},
@@ -496,29 +213,18 @@
"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": {
- "view": {
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
"required": true,
"type": "string",
"location": "path"
},
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- },
"pageToken": {
"location": "query",
"description": "Continuation token for fetching the next page of results.",
@@ -529,45 +235,6 @@
"format": "int32",
"type": "integer",
"location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
- },
- "get": {
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.",
- "response": {
- "$ref": "Version"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- },
- "versionsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
},
"view": {
"location": "query",
@@ -575,21 +242,74 @@
"BASIC",
"FULL"
],
- "description": "Controls the set of fields returned in the Get response.",
+ "description": "Controls the set of fields returned in the List response.",
"type": "string"
},
"servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
+ "location": "path"
}
},
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "get": {
+ "id": "appengine.apps.services.versions.get",
"path": "v1alpha/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.",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "response": {
+ "$ref": "Version"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string",
+ "location": "query"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/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/v1alpha/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/v1alpha/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/v1alpha/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/v1alpha/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "request": {
+ "$ref": "Version"
+ },
"response": {
"$ref": "Operation"
},
@@ -603,12 +323,6 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"updateMask": {
"description": "Standard field mask for the set of fields to be updated.",
"format": "google-fieldmask",
@@ -616,33 +330,29 @@
"location": "query"
},
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
"location": "path",
"description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
"required": true,
"type": "string"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
"path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/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/v1alpha/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/v1alpha/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/v1alpha/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- }
+ "id": "appengine.apps.services.versions.patch"
},
"create": {
- "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "request": {
- "$ref": "Version"
- },
- "description": "Deploys code and resource files to a new version.",
"response": {
"$ref": "Operation"
},
@@ -653,29 +363,80 @@
"httpMethod": "POST",
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions"
+ "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys code and resource files to a new version."
}
},
"resources": {
"instances": {
"methods": {
+ "delete": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId",
+ "instancesId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
+ "instancesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
+ "id": "appengine.apps.services.versions.instances.delete",
+ "description": "Stops a running instance."
+ },
"list": {
- "description": "Lists the instances of a version.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListInstancesResponse"
},
@@ -684,19 +445,12 @@
"servicesId",
"versionsId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"appsId": {
"description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.",
"required": true,
@@ -704,9 +458,9 @@
"location": "path"
},
"pageToken": {
- "location": "query",
"description": "Continuation token for fetching the next page of results.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"location": "query",
@@ -719,36 +473,44 @@
"required": true,
"type": "string",
"location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
+ "id": "appengine.apps.services.versions.instances.list",
"path": "v1alpha/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": {
- "httpMethod": "GET",
+ "description": "Gets instance information.",
+ "response": {
+ "$ref": "Instance"
+ },
"parameterOrder": [
"appsId",
"servicesId",
"versionsId",
"instancesId"
],
- "response": {
- "$ref": "Instance"
- },
+ "httpMethod": "GET",
"parameters": {
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
- "required": true,
"type": "string",
"location": "path"
},
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
+ "required": true,
+ "type": "string"
+ },
"instancesId": {
"location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
@@ -768,18 +530,10 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.get",
"path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "description": "Gets instance information."
+ "id": "appengine.apps.services.versions.instances.get"
},
"debug": {
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
"response": {
"$ref": "Operation"
},
@@ -801,58 +555,16 @@
"type": "string"
},
"instancesId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "versionsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
- }
- }
- },
- "delete": {
- "description": "Stops a running instance.",
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId",
- "instancesId"
- ],
- "httpMethod": "DELETE",
- "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/versions/v1/instances/instance-1.",
- "required": true,
"type": "string",
"location": "path"
},
- "instancesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"servicesId": {
"location": "path",
@@ -861,45 +573,292 @@
"type": "string"
}
},
- "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete"
+ "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ }
}
}
}
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "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": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation collection.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "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 below allows API services to override the binding to use different resource name schemes, such as users/*/operations."
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "operationsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "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."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list",
+ "path": "v1alpha/apps/{appsId}/locations"
+ },
+ "get": {
+ "id": "appengine.apps.locations.get",
+ "path": "v1alpha/apps/{appsId}/locations/{locationsId}",
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string"
+ },
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}"
+ }
+ }
+ }
+ },
+ "methods": {
+ "repair": {
+ "request": {
+ "$ref": "RepairApplicationRequest"
+ },
+ "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}:repair",
+ "path": "v1alpha/apps/{appsId}:repair",
+ "id": "appengine.apps.repair"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "Application"
+ },
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1alpha/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "path": "v1alpha/apps/{appsId}",
+ "description": "Gets information about an application."
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "appsId": {
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha/apps/{appsId}",
+ "path": "v1alpha/apps/{appsId}",
+ "id": "appengine.apps.patch",
+ "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.",
+ "request": {
+ "$ref": "Application"
+ }
+ },
+ "create": {
+ "path": "v1alpha/apps",
+ "id": "appengine.apps.create",
+ "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
+ "request": {
+ "$ref": "Application"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1alpha/apps"
}
}
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -907,19 +866,14 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "callback": {
+ "fields": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
@@ -935,6 +889,11 @@
],
"location": "query"
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"alt": {
"enum": [
"json",
@@ -951,20 +910,482 @@
"description": "Data format for response.",
"default": "json"
},
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "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"
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"schemas": {
+ "RequestUtilization": {
+ "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
+ "type": "object",
+ "properties": {
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetConcurrentRequests": {
+ "description": "Target number of concurrent requests.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RequestUtilization"
+ },
+ "UrlMap": {
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object",
+ "properties": {
+ "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": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
+ },
+ "urlRegex": {
+ "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
+ "type": "string"
+ },
+ "login": {
+ "enum": [
+ "LOGIN_UNSPECIFIED",
+ "LOGIN_OPTIONAL",
+ "LOGIN_ADMIN",
+ "LOGIN_REQUIRED"
+ ],
+ "description": "Level of login required to access this resource.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. LOGIN_OPTIONAL is assumed.",
+ "Does not require that the user is signed in.",
+ "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
+ "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
+ ]
+ },
+ "apiEndpoint": {
+ "description": "Uses API Endpoints to handle requests.",
+ "$ref": "ApiEndpointHandler"
+ },
+ "staticFiles": {
+ "description": "Returns the contents of a file, such as an image, as the response.",
+ "$ref": "StaticFilesHandler"
+ },
+ "redirectHttpResponseCode": {
+ "enumDescriptions": [
+ "Not specified. 302 is assumed.",
+ "301 Moved Permanently code.",
+ "302 Moved Temporarily code.",
+ "303 See Other code.",
+ "307 Temporary Redirect code."
+ ],
+ "enum": [
+ "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
+ "REDIRECT_HTTP_RESPONSE_CODE_301",
+ "REDIRECT_HTTP_RESPONSE_CODE_302",
+ "REDIRECT_HTTP_RESPONSE_CODE_303",
+ "REDIRECT_HTTP_RESPONSE_CODE_307"
+ ],
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string"
+ }
+ },
+ "id": "UrlMap"
+ },
+ "EndpointsApiService": {
+ "properties": {
+ "name": {
+ "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
+ "type": "string"
+ },
+ "configId": {
+ "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
+ "type": "string"
+ }
+ },
+ "id": "EndpointsApiService",
+ "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
+ "type": "object"
+ },
+ "Operation": {
+ "properties": {
+ "done": {
+ "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "type": "object"
+ },
+ "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": {
+ "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"
+ },
+ "StaticFilesHandler": {
+ "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
+ "type": "object",
+ "properties": {
+ "applicationReadable": {
+ "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
+ "type": "boolean"
+ },
+ "httpHeaders": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object"
+ },
+ "uploadPathRegex": {
+ "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
+ "type": "string"
+ },
+ "path": {
+ "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
+ "type": "string"
+ },
+ "mimeType": {
+ "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
+ "type": "string"
+ },
+ "requireMatchingFile": {
+ "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
+ "format": "google-duration",
+ "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": {
+ "idleTimeout": {
+ "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxInstances": {
+ "description": "Maximum number of instances to create for this version.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "BasicScaling"
+ },
+ "DiskUtilization": {
+ "properties": {
+ "targetReadBytesPerSecond": {
+ "description": "Target bytes read per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteOpsPerSecond": {
+ "description": "Target ops written per second.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetWriteBytesPerSecond": {
+ "description": "Target bytes written per second.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskUtilization",
+ "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
+ "type": "object"
+ },
+ "CpuUtilization": {
+ "properties": {
+ "aggregationWindowLength": {
+ "description": "Period of time over which CPU utilization is calculated.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "targetUtilization": {
+ "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "CpuUtilization",
+ "description": "Target scaling by CPU usage.",
+ "type": "object"
+ },
+ "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"
+ },
+ "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 will be a common set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which 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 purpose.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
+ },
+ "ManualScaling": {
+ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
+ "type": "object",
+ "properties": {
+ "instances": {
+ "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ManualScaling"
+ },
+ "LocationMetadata": {
+ "description": "Metadata for the given google.cloud.location.Location.",
+ "type": "object",
+ "properties": {
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ },
+ "flexibleEnvironmentAvailable": {
+ "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
+ }
+ },
+ "id": "LocationMetadata"
+ },
+ "Service": {
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
+ "split": {
+ "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
+ "$ref": "TrafficSplit"
+ },
+ "id": {
+ "description": "Relative name of the service within the application. Example: default.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Service"
+ },
+ "ListOperationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
"OperationMetadata": {
"properties": {
+ "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"
@@ -982,14 +1403,6 @@
"description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
- "type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
}
},
"id": "OperationMetadata",
@@ -997,8 +1410,16 @@
"type": "object"
},
"OperationMetadataV1": {
- "type": "object",
"properties": {
+ "method": {
+ "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -1011,30 +1432,22 @@
"format": "google-datetime",
"type": "string"
},
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
- "type": "string"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
+ "type": "string"
+ },
"ephemeralMessage": {
"description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
- },
- "method": {
- "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "OperationMetadataV1",
- "description": "Metadata for the given google.longrunning.Operation."
+ "description": "Metadata for the given google.longrunning.Operation.",
+ "type": "object"
},
"ErrorHandler": {
"description": "Custom static error page to be served when an error occurs.",
@@ -1069,57 +1482,9 @@
},
"id": "ErrorHandler"
},
- "Application": {
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application.",
- "type": "object",
- "properties": {
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "codeBucket": {
- "description": "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": {
- "type": "string",
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly"
- },
- "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"
- }
- }
- },
"Network": {
+ "description": "Extra network settings. Only applicable for VM runtimes.",
+ "type": "object",
"properties": {
"forwardedPorts": {
"description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
@@ -1141,75 +1506,102 @@
"type": "string"
}
},
- "id": "Network",
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "type": "object"
+ "id": "Network"
},
- "Instance": {
- "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
- "type": "object",
+ "Application": {
"properties": {
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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"
},
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
+ "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."
+ ]
},
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
"type": "string"
},
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "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.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
"type": "string"
},
"name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
"type": "string"
},
- "averageLatency": {
- "description": "Average latency (ms) over the last minute.@OutputOnly",
- "format": "int32",
- "type": "integer"
- },
- "vmIp": {
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "memoryUsage": {
- "description": "Total memory in use (bytes).@OutputOnly",
- "format": "int64",
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
"type": "string"
},
"id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "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"
- },
- "vmStatus": {
- "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
+ }
+ },
+ "id": "Application",
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object"
+ },
+ "Instance": {
+ "properties": {
+ "errors": {
+ "description": "Number of errors since this instance was started.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
},
"availability": {
- "enumDescriptions": [
- "",
- "",
- ""
- ],
"enum": [
"UNSPECIFIED",
"RESIDENT",
"DYNAMIC"
],
"description": "Availability of the instance.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ]
},
- "errors": {
- "description": "Number of errors since this instance was started.@OutputOnly",
- "format": "int32",
- "type": "integer"
+ "vmStatus": {
+ "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
},
"startTime": {
"description": "Time that this instance was started.@OutputOnly",
@@ -1228,23 +1620,56 @@
"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": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "averageLatency": {
+ "description": "Average latency (ms) over the last minute.@OutputOnly",
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "memoryUsage": {
+ "description": "Total memory in use (bytes).@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
}
},
- "id": "Instance"
+ "id": "Instance",
+ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.",
+ "type": "object"
},
"LivenessCheck": {
- "id": "LivenessCheck",
- "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
- "type": "object",
"properties": {
- "unhealthyThreshold": {
- "type": "integer",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32"
- },
"path": {
- "type": "string",
- "description": "The request path."
+ "description": "The request path.",
+ "type": "string"
},
"host": {
"description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
@@ -1269,20 +1694,21 @@
"description": "The initial delay before starting to execute the checks.",
"format": "google-duration",
"type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
}
- }
+ },
+ "id": "LivenessCheck",
+ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
+ "type": "object"
},
"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"
@@ -1298,6 +1724,13 @@
},
"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"
@@ -1306,11 +1739,6 @@
"description": "Target scaling by network usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetReceivedPacketsPerSecond": {
- "description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
- },
"targetSentBytesPerSecond": {
"description": "Target bytes sent per second.",
"format": "int32",
@@ -1325,15 +1753,32 @@
"description": "Target bytes received per second.",
"format": "int32",
"type": "integer"
+ },
+ "targetReceivedPacketsPerSecond": {
+ "description": "Target packets received per second.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "NetworkUtilization"
},
"HealthCheck": {
- "id": "HealthCheck",
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.",
"type": "object",
"properties": {
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
+ },
"healthyThreshold": {
"description": "Number of consecutive successful health checks required before receiving traffic.",
"format": "uint32",
@@ -1353,31 +1798,14 @@
"description": "Time before the health check is considered failed.",
"format": "google-duration",
"type": "string"
- },
- "unhealthyThreshold": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
- "disableHealthCheck": {
- "type": "boolean",
- "description": "Whether to explicitly disable health checks for this instance."
- },
- "host": {
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
- "type": "string"
}
- }
+ },
+ "id": "HealthCheck"
},
"ReadinessCheck": {
"description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
"type": "object",
"properties": {
- "unhealthyThreshold": {
- "description": "Number of consecutive failed checks required before removing traffic.",
- "format": "uint32",
- "type": "integer"
- },
"path": {
"description": "The request path.",
"type": "string"
@@ -1400,12 +1828,16 @@
"description": "Time before the check is considered failed.",
"format": "google-duration",
"type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
}
},
"id": "ReadinessCheck"
},
"DebugInstanceRequest": {
- "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).",
@@ -1413,7 +1845,8 @@
}
},
"id": "DebugInstanceRequest",
- "description": "Request message for Instances.DebugInstance."
+ "description": "Request message for Instances.DebugInstance.",
+ "type": "object"
},
"OperationMetadataV1Beta5": {
"description": "Metadata for the given google.longrunning.Operation.",
@@ -1424,9 +1857,9 @@
"type": "string"
},
"insertTime": {
- "type": "string",
"description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"endTime": {
"description": "Timestamp that this operation completed.@OutputOnly",
@@ -1445,152 +1878,17 @@
"id": "OperationMetadataV1Beta5"
},
"Version": {
+ "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
- "automaticScaling": {
- "$ref": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "diskUsageBytes": {
- "type": "string",
- "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
- "format": "int64"
- },
- "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": {
- "type": "boolean",
- "description": "Whether multiple requests can be dispatched to this version at once."
- },
- "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": {
- "$ref": "ApiConfigHandler",
- "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
- },
- "endpointsApiService": {
- "$ref": "EndpointsApiService",
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app."
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "instanceClass": {
- "type": "string",
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling."
- },
- "servingStatus": {
- "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"
- ],
- "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."
- },
- "deployment": {
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
- "$ref": "Deployment"
- },
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "inboundServices": {
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "INBOUND_SERVICE_UNSPECIFIED",
- "INBOUND_SERVICE_MAIL",
- "INBOUND_SERVICE_MAIL_BOUNCE",
- "INBOUND_SERVICE_XMPP_ERROR",
- "INBOUND_SERVICE_XMPP_MESSAGE",
- "INBOUND_SERVICE_XMPP_SUBSCRIBE",
- "INBOUND_SERVICE_XMPP_PRESENCE",
- "INBOUND_SERVICE_CHANNEL_PRESENCE",
- "INBOUND_SERVICE_WARMUP"
- ]
- },
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ]
- },
- "resources": {
- "description": "Machine resources for this version. Only applicable for VM runtimes.",
- "$ref": "Resources"
- },
- "errorHandlers": {
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- },
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set."
- },
- "defaultExpiration": {
- "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
- "format": "google-duration",
- "type": "string"
- },
- "libraries": {
- "type": "array",
- "items": {
- "$ref": "Library"
- },
- "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set."
- },
- "nobuildFilesRegex": {
- "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
- "type": "string"
- },
- "basicScaling": {
- "$ref": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
- },
- "runtime": {
- "description": "Desired runtime. Example: python27.",
+ "createdBy": {
+ "description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
"id": {
"description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
"type": "string"
},
- "createdBy": {
- "description": "Email address of the user who created this version.@OutputOnly",
- "type": "string"
- },
"envVariables": {
"additionalProperties": {
"type": "string"
@@ -1599,8 +1897,8 @@
"type": "object"
},
"livenessCheck": {
- "$ref": "LivenessCheck",
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
+ "$ref": "LivenessCheck"
},
"network": {
"$ref": "Network",
@@ -1623,16 +1921,151 @@
"items": {
"$ref": "UrlMap"
}
+ },
+ "automaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "$ref": "AutomaticScaling"
+ },
+ "diskUsageBytes": {
+ "description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
+ "format": "int64",
+ "type": "string"
+ },
+ "healthCheck": {
+ "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable 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": {
+ "$ref": "ApiConfigHandler",
+ "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
+ },
+ "endpointsApiService": {
+ "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
+ "$ref": "EndpointsApiService"
+ },
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string"
+ },
+ "deployment": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
+ },
+ "createTime": {
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "inboundServices": {
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
+ },
+ "resources": {
+ "description": "Machine resources for this version. Only applicable for VM runtimes.",
+ "$ref": "Resources"
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorHandler"
+ }
+ },
+ "defaultExpiration": {
+ "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1alpha/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "libraries": {
+ "description": "Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "Library"
+ }
+ },
+ "nobuildFilesRegex": {
+ "description": "Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.",
+ "type": "string"
+ },
+ "basicScaling": {
+ "$ref": "BasicScaling",
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ },
+ "runtime": {
+ "description": "Desired runtime. Example: python27.",
+ "type": "string"
}
},
- "id": "Version",
- "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service."
+ "id": "Version"
},
"RepairApplicationRequest": {
- "description": "Request message for 'Applications.RepairApplication'.",
- "type": "object",
"properties": {},
- "id": "RepairApplicationRequest"
+ "id": "RepairApplicationRequest",
+ "description": "Request message for 'Applications.RepairApplication'.",
+ "type": "object"
},
"ScriptHandler": {
"properties": {
@@ -1646,8 +2079,6 @@
"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": {
"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'.",
@@ -1658,17 +2089,26 @@
"type": "string"
},
"mimeType": {
- "type": "string",
- "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage."
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.",
+ "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"
},
"OperationMetadataExperimental": {
- "id": "OperationMetadataExperimental",
"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/customDomains/example.com.@OutputOnly",
+ "type": "string"
+ },
"method": {
"description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
"type": "string"
@@ -1682,32 +2122,24 @@
"description": "Time that this operation completed.@OutputOnly",
"format": "google-datetime",
"type": "string"
- },
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
- "target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
}
- }
+ },
+ "id": "OperationMetadataExperimental"
},
"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",
"properties": {
"shardBy": {
"enumDescriptions": [
"Diversion method unspecified.",
"Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
+ "Diversion based on 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"
+ "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"
@@ -1720,16 +2152,15 @@
"description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
"type": "object"
}
- }
+ },
+ "id": "TrafficSplit",
+ "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": {
"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"
@@ -1747,24 +2178,26 @@
}
},
"insertTime": {
- "type": "string",
"description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "user": {
+ "description": "User who requested this operation.@OutputOnly",
+ "type": "string"
},
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
+ "ephemeralMessage": {
+ "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly",
"type": "string"
}
},
"id": "OperationMetadataV1Beta"
},
"ListServicesResponse": {
- "description": "Response message for Services.ListServices.",
- "type": "object",
"properties": {
"services": {
"description": "The services belonging to the requested application.",
@@ -1778,33 +2211,33 @@
"type": "string"
}
},
- "id": "ListServicesResponse"
+ "id": "ListServicesResponse",
+ "description": "Response message for Services.ListServices.",
+ "type": "object"
},
"Deployment": {
"description": "Code and application artifacts used to deploy a version to App Engine.",
"type": "object",
"properties": {
- "zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
- },
- "container": {
- "$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"
+ },
+ "zip": {
+ "description": "The zip file for this deployment, if this is a zip deployment.",
+ "$ref": "ZipInfo"
+ },
+ "container": {
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
+ "$ref": "ContainerInfo"
}
},
"id": "Deployment"
},
"Resources": {
- "description": "Machine resources for a version.",
- "type": "object",
"properties": {
"volumes": {
"description": "User specified volumes.",
@@ -1829,12 +2262,16 @@
"type": "number"
}
},
- "id": "Resources"
+ "id": "Resources",
+ "description": "Machine resources for a version.",
+ "type": "object"
},
"Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
+ "volumeType": {
+ "description": "Underlying volume type, e.g. 'tmpfs'.",
+ "type": "string"
+ },
"sizeGb": {
"description": "Volume size in gigabytes.",
"format": "double",
@@ -1843,39 +2280,32 @@
"name": {
"description": "Unique name for the volume.",
"type": "string"
- },
- "volumeType": {
- "description": "Underlying volume type, e.g. 'tmpfs'.",
- "type": "string"
}
},
- "id": "Volume"
+ "id": "Volume",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object"
},
"ListInstancesResponse": {
- "description": "Response message for Instances.ListInstances.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "Continuation token for fetching the next page of results.",
- "type": "string"
- },
"instances": {
"description": "The instances belonging to the requested version.",
"type": "array",
"items": {
"$ref": "Instance"
}
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
}
},
- "id": "ListInstancesResponse"
+ "id": "ListInstancesResponse",
+ "description": "Response message for Instances.ListInstances.",
+ "type": "object"
},
"OperationMetadataV1Alpha": {
"properties": {
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -1883,6 +2313,11 @@
"type": "string"
}
},
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -1912,8 +2347,8 @@
"UrlDispatchRule": {
"properties": {
"path": {
- "type": "string",
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters."
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
},
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
@@ -1957,29 +2392,20 @@
"description": "Uses Google Cloud Endpoints to handle requests.",
"type": "object"
},
- "ZipInfo": {
- "properties": {
- "filesCount": {
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "format": "int32",
- "type": "integer"
- },
- "sourceUrl": {
- "type": "string",
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'."
- }
- },
- "id": "ZipInfo",
- "description": "The zip file information for a zip deployment.",
- "type": "object"
- },
"AutomaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "type": "object",
"properties": {
+ "diskUtilization": {
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
"requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
+ "description": "Target scaling by request utilization.",
+ "$ref": "RequestUtilization"
},
"maxIdleInstances": {
"description": "Maximum number of idle instances that should be maintained for this version.",
@@ -2002,8 +2428,8 @@
"type": "integer"
},
"networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
},
"maxConcurrentRequests": {
"description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
@@ -2021,20 +2447,29 @@
"type": "string"
},
"cpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "$ref": "CpuUtilization"
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- },
- "minPendingLatency": {
- "type": "string",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration"
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
}
},
- "id": "AutomaticScaling"
+ "id": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object"
+ },
+ "ZipInfo": {
+ "properties": {
+ "filesCount": {
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "ZipInfo",
+ "description": "The zip file information for a zip deployment.",
+ "type": "object"
},
"Library": {
"description": "Third-party Python runtime library that is required by the application.",
@@ -2052,8 +2487,6 @@
"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.",
@@ -2063,11 +2496,13 @@
}
},
"nextPageToken": {
- "type": "string",
- "description": "The standard List next-page token."
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListLocationsResponse"
+ "id": "ListLocationsResponse",
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object"
},
"ContainerInfo": {
"description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.",
@@ -2079,444 +2514,31 @@
}
},
"id": "ContainerInfo"
- },
- "RequestUtilization": {
- "description": "Target scaling by request utilization. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetConcurrentRequests": {
- "description": "Target number of concurrent requests.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "RequestUtilization"
- },
- "EndpointsApiService": {
- "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).",
- "type": "object",
- "properties": {
- "name": {
- "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"",
- "type": "string"
- },
- "configId": {
- "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
- "type": "string"
- }
- },
- "id": "EndpointsApiService"
- },
- "UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
- "properties": {
- "script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
- },
- "urlRegex": {
- "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.",
- "type": "string"
- },
- "login": {
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- },
- "redirectHttpResponseCode": {
- "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. 302 is assumed.",
- "301 Moved Permanently code.",
- "302 Moved Temporarily code.",
- "303 See Other code.",
- "307 Temporary Redirect code."
- ],
- "enum": [
- "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED",
- "REDIRECT_HTTP_RESPONSE_CODE_301",
- "REDIRECT_HTTP_RESPONSE_CODE_302",
- "REDIRECT_HTTP_RESPONSE_CODE_303",
- "REDIRECT_HTTP_RESPONSE_CODE_307"
- ]
- },
- "securityLevel": {
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ],
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ]
- },
- "authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
- }
- },
- "id": "UrlMap"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "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": {
- "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"
- }
- }
- },
- "id": "Operation"
- },
- "ApiConfigHandler": {
- "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. Defaults to optional.",
- "type": "string"
- },
- "url": {
- "description": "URL to serve the endpoint at.",
- "type": "string"
- },
- "securityLevel": {
- "description": "Security (HTTPS) enforcement for this URL.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.",
- "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.",
- "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.",
- "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect."
- ],
- "enum": [
- "SECURE_UNSPECIFIED",
- "SECURE_DEFAULT",
- "SECURE_NEVER",
- "SECURE_OPTIONAL",
- "SECURE_ALWAYS"
- ]
- },
- "authFailAction": {
- "enumDescriptions": [
- "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
- "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
- "Rejects request with a 401 HTTP status code and an error message."
- ],
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string"
- },
- "script": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
- }
- },
- "id": "ApiConfigHandler",
- "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers."
- },
- "StaticFilesHandler": {
- "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
- "type": "object",
- "properties": {
- "expiration": {
- "description": "Time a static file served by this handler should be cached by web proxies and browsers.",
- "format": "google-duration",
- "type": "string"
- },
- "applicationReadable": {
- "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
- "type": "boolean"
- },
- "httpHeaders": {
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "uploadPathRegex": {
- "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.",
- "type": "string"
- },
- "path": {
- "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.",
- "type": "string"
- },
- "mimeType": {
- "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.",
- "type": "string"
- },
- "requireMatchingFile": {
- "description": "Whether this handler should match the request if the file referenced by the handler does not exist.",
- "type": "boolean"
- }
- },
- "id": "StaticFilesHandler"
- },
- "DiskUtilization": {
- "description": "Target scaling by disk usage. Only applicable for VM runtimes.",
- "type": "object",
- "properties": {
- "targetReadBytesPerSecond": {
- "type": "integer",
- "description": "Target bytes read per second.",
- "format": "int32"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteOpsPerSecond": {
- "description": "Target ops written per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetWriteBytesPerSecond": {
- "description": "Target bytes written per second.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DiskUtilization"
- },
- "BasicScaling": {
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
- "type": "object",
- "properties": {
- "maxInstances": {
- "description": "Maximum number of instances to create for this version.",
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "BasicScaling"
- },
- "CpuUtilization": {
- "description": "Target scaling by CPU usage.",
- "type": "object",
- "properties": {
- "aggregationWindowLength": {
- "description": "Period of time over which CPU utilization is calculated.",
- "format": "google-duration",
- "type": "string"
- },
- "targetUtilization": {
- "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CpuUtilization"
- },
- "Status": {
- "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which 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 purpose.\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 will be a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- }
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "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": "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"
- },
- "ManualScaling": {
- "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
- "type": "object",
- "properties": {
- "instances": {
- "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ManualScaling"
- },
- "LocationMetadata": {
- "description": "Metadata for the given google.cloud.location.Location.",
- "type": "object",
- "properties": {
- "flexibleEnvironmentAvailable": {
- "description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- }
- },
- "id": "LocationMetadata"
- },
- "Service": {
- "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",
- "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."
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse"
}
},
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest"
+ "protocol": "rest",
+ "version": "v1alpha",
+ "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": "Provisions and manages App Engine applications.",
+ "servicePath": ""
}
diff --git a/appengine/v1alpha/appengine-gen.go b/appengine/v1alpha/appengine-gen.go
index 399196e..172b28d 100644
--- a/appengine/v1alpha/appengine-gen.go
+++ b/appengine/v1alpha/appengine-gen.go
@@ -295,6 +295,10 @@
// are order-dependent.@OutputOnly
DispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"`
+ // GcrDomain: The Google Container Registry domain used for storing
+ // managed build docker images for this application.
+ GcrDomain string `json:"gcrDomain,omitempty"`
+
Iap *IdentityAwareProxy `json:"iap,omitempty"`
// Id: Identifier of the Application resource. This identifier is
@@ -313,6 +317,15 @@
// apps/myapp.@OutputOnly
Name string `json:"name,omitempty"`
+ // ServingStatus: Serving status of this application.
+ //
+ // Possible values:
+ // "UNSPECIFIED" - Serving status is unspecified.
+ // "SERVING" - Application is serving.
+ // "USER_DISABLED" - Application has been disabled by the user.
+ // "SYSTEM_DISABLED" - Application has been disabled by the system.
+ ServingStatus string `json:"servingStatus,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -2184,6 +2197,9 @@
// diversion will occur.
// "IP" - Diversion based on applying the modulus operation to a
// fingerprint of the IP address.
+ // "RANDOM" - 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.
ShardBy string `json:"shardBy,omitempty"`
// ForceSendFields is a list of field names (e.g. "Allocations") to
@@ -5956,7 +5972,10 @@
header_ http.Header
}
-// List: Lists the instances of a version.
+// List: 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.timeS
+// eries/list).
func (r *AppsServicesVersionsInstancesService) List(appsId string, servicesId string, versionsId string) *AppsServicesVersionsInstancesListCall {
c := &AppsServicesVersionsInstancesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -6076,7 +6095,7 @@
}
return ret, nil
// {
- // "description": "Lists the instances of a version.",
+ // "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).",
// "flatPath": "v1alpha/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
// "httpMethod": "GET",
// "id": "appengine.apps.services.versions.instances.list",
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json
index 5ba2ca6..ad4b761 100644
--- a/appengine/v1beta/appengine-api.json
+++ b/appengine/v1beta/appengine-api.json
@@ -1,115 +1,17 @@
{
- "version": "v1beta",
- "baseUrl": "https://appengine.googleapis.com/",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/appengine.admin": {
- "description": "View and manage your applications deployed on Google App Engine"
- },
- "https://www.googleapis.com/auth/cloud-platform.read-only": {
- "description": "View your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "servicePath": "",
- "description": "Provisions and manages App Engine applications.",
- "kind": "discovery#restDescription",
- "rootUrl": "https://appengine.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "appengine",
"batchPath": "batch",
- "revision": "20170221",
- "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
+ "revision": "20170302",
"id": "appengine:v1beta",
+ "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/",
"title": "Google App Engine Admin API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"apps": {
"methods": {
- "get": {
- "description": "Gets information about an application.",
- "response": {
- "$ref": "Application"
- },
- "parameterOrder": [
- "appsId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}",
- "path": "v1beta/apps/{appsId}",
- "id": "appengine.apps.get"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps/{appsId}",
- "id": "appengine.apps.patch",
- "path": "v1beta/apps/{appsId}",
- "request": {
- "$ref": "Application"
- },
- "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application."
- },
- "create": {
- "request": {
- "$ref": "Application"
- },
- "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta/apps",
- "path": "v1beta/apps",
- "id": "appengine.apps.create"
- },
"repair": {
"request": {
"$ref": "RepairApplicationRequest"
@@ -124,10 +26,10 @@
"httpMethod": "POST",
"parameters": {
"appsId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "Part of `name`. Name of the application to repair. Example: apps/myapp"
+ "description": "Part of `name`. Name of the application to repair. Example: apps/myapp",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
@@ -136,9 +38,244 @@
"flatPath": "v1beta/apps/{appsId}:repair",
"path": "v1beta/apps/{appsId}:repair",
"id": "appengine.apps.repair"
+ },
+ "get": {
+ "parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}",
+ "path": "v1beta/apps/{appsId}",
+ "id": "appengine.apps.get",
+ "description": "Gets information about an application.",
+ "response": {
+ "$ref": "Application"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "GET"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp."
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "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."
+ },
+ "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"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps",
+ "id": "appengine.apps.create",
+ "path": "v1beta/apps"
}
},
"resources": {
+ "operations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "appsId"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. The name of the operation collection.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/operations",
+ "id": "appengine.apps.operations.list",
+ "path": "v1beta/apps/{appsId}/operations",
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations."
+ },
+ "get": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "operationsId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "operationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. The name of the operation resource."
+ }
+ },
+ "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}",
+ "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."
+ }
+ }
+ },
+ "locations": {
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "parameterOrder": [
+ "appsId"
+ ],
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. The resource that owns the locations collection, if applicable."
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/locations",
+ "path": "v1beta/apps/{appsId}/locations",
+ "id": "appengine.apps.locations.list"
+ },
+ "get": {
+ "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "id": "appengine.apps.locations.get",
+ "path": "v1beta/apps/{appsId}/locations/{locationsId}",
+ "description": "Get information about a location.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "locationsId"
+ ],
+ "response": {
+ "$ref": "Location"
+ },
+ "parameters": {
+ "locationsId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Resource name for the location.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ]
+ }
+ }
+ },
"services": {
"methods": {
"delete": {
@@ -147,45 +284,53 @@
"path": "v1beta/apps/{appsId}/services/{servicesId}",
"description": "Deletes the specified service and all enclosed versions.",
"httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"appsId",
"servicesId"
],
- "response": {
- "$ref": "Operation"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
"type": "string",
"location": "path"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ }
},
"list": {
- "httpMethod": "GET",
+ "path": "v1beta/apps/{appsId}/services",
+ "id": "appengine.apps.services.list",
+ "description": "Lists all the services in the application.",
"response": {
"$ref": "ListServicesResponse"
},
+ "httpMethod": "GET",
"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": {
"appsId": {
+ "location": "path",
"description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"pageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -199,57 +344,46 @@
"type": "integer"
}
},
+ "flatPath": "v1beta/apps/{appsId}/services"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Service"
+ },
"scopes": [
"https://www.googleapis.com/auth/appengine.admin",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "flatPath": "v1beta/apps/{appsId}/services",
- "id": "appengine.apps.services.list",
- "path": "v1beta/apps/{appsId}/services",
- "description": "Lists all the services in the application."
- },
- "get": {
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "httpMethod": "GET",
"parameters": {
+ "appsId": {
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string"
+ },
"servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
- },
- "appsId": {
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
}
},
- "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}",
- "path": "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."
},
"patch": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}",
- "id": "appengine.apps.services.patch",
+ "description": "Updates the configuration of the specified service.",
"request": {
"$ref": "Service"
},
- "description": "Updates the configuration of the specified service.",
"response": {
"$ref": "Operation"
},
@@ -258,18 +392,10 @@
"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.",
- "required": true,
- "type": "string"
- },
- "migrateTraffic": {
- "location": "query",
- "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).",
- "type": "boolean"
- },
"updateMask": {
"location": "query",
"description": "Standard field mask for the set of fields to be updated.",
@@ -277,246 +403,35 @@
"type": "string"
},
"servicesId": {
+ "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default."
+ },
+ "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"
}
},
"resources": {
"versions": {
- "methods": {
- "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": {
- "view": {
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Controls the set of fields returned in the List response.",
- "type": "string",
- "location": "query"
- },
- "servicesId": {
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "appsId": {
- "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Continuation token for fetching the next page of results."
- },
- "pageSize": {
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.list"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Version"
- },
- "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": {
- "versionsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "description": "Controls the set of fields returned in the Get response.",
- "type": "string",
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ]
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.get",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource."
- },
- "patch": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "versionsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "updateMask": {
- "location": "query",
- "description": "Standard field mask for the set of fields to be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "servicesId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
- "id": "appengine.apps.services.versions.patch",
- "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
- "request": {
- "$ref": "Version"
- }
- },
- "create": {
- "description": "Deploys code and resource files to a new version.",
- "request": {
- "$ref": "Version"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "appsId",
- "servicesId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "servicesId": {
- "location": "path",
- "description": "Part of `parent`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "appsId": {
- "location": "path",
- "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
- "id": "appengine.apps.services.versions.create",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions"
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "servicesId",
- "versionsId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "appsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1."
- },
- "versionsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- },
- "servicesId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- }
- },
- "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."
- }
- },
"resources": {
"instances": {
"methods": {
"delete": {
+ "description": "Stops a running instance.",
"response": {
"$ref": "Operation"
},
@@ -527,18 +442,21 @@
"instancesId"
],
"httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"appsId": {
- "location": "path",
- "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1."
},
"instancesId": {
"location": "path",
@@ -547,22 +465,18 @@
"type": "string"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}",
- "id": "appengine.apps.services.versions.instances.delete",
- "description": "Stops a running instance."
+ "id": "appengine.apps.services.versions.instances.delete"
},
"list": {
- "description": "Lists the instances of a version.",
+ "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"
@@ -572,7 +486,18 @@
"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",
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
"versionsId": {
"description": "Part of `parent`. See documentation of `appsId`.",
"required": true,
@@ -595,34 +520,24 @@
"description": "Continuation token for fetching the next page of results.",
"type": "string",
"location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum results to return per page.",
- "format": "int32",
- "type": "integer"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
"id": "appengine.apps.services.versions.instances.list",
"path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances"
},
"get": {
- "response": {
- "$ref": "Instance"
- },
+ "description": "Gets instance information.",
+ "httpMethod": "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",
@@ -630,43 +545,35 @@
],
"parameters": {
"appsId": {
+ "location": "path",
"description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"instancesId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "versionsId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`."
- },
- "servicesId": {
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
"location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string"
}
},
"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."
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}"
},
"debug": {
- "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
- "id": "appengine.apps.services.versions.instances.debug",
- "request": {
- "$ref": "DebugInstanceRequest"
- },
- "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
"response": {
"$ref": "Operation"
},
@@ -677,12 +584,15 @@
"instancesId"
],
"httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"servicesId": {
- "description": "Part of `name`. See documentation of `appsId`.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
},
"appsId": {
"location": "path",
@@ -697,211 +607,272 @@
"type": "string"
},
"versionsId": {
- "location": "path",
"description": "Part of `name`. See documentation of `appsId`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug",
+ "id": "appengine.apps.services.versions.instances.debug",
+ "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.",
+ "request": {
+ "$ref": "DebugInstanceRequest"
+ }
}
}
}
+ },
+ "methods": {
+ "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`.",
+ "required": true,
+ "type": "string"
+ },
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Continuation token for fetching the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum results to return per page.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "description": "Controls the set of fields returned in the List response.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ]
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.list"
+ },
+ "get": {
+ "parameters": {
+ "appsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1."
+ },
+ "versionsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Controls the set of fields returned in the Get response.",
+ "type": "string"
+ },
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/appengine.admin",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "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.",
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Version"
+ }
+ },
+ "patch": {
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "id": "appengine.apps.services.versions.patch",
+ "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.",
+ "request": {
+ "$ref": "Version"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "appsId",
+ "servicesId",
+ "versionsId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "servicesId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "description": "Part of `name`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ },
+ "create": {
+ "request": {
+ "$ref": "Version"
+ },
+ "description": "Deploys code and resource files to a new version.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "appsId",
+ "servicesId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "appsId": {
+ "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "servicesId": {
+ "description": "Part of `parent`. See documentation of `appsId`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions",
+ "id": "appengine.apps.services.versions.create",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions"
+ },
+ "delete": {
+ "id": "appengine.apps.services.versions.delete",
+ "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}",
+ "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`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "appsId": {
+ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "versionsId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Part of `name`. See documentation of `appsId`."
+ }
+ },
+ "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}"
+ }
}
}
}
- },
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
- "parameterOrder": [
- "appsId"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation collection.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta/apps/{appsId}/operations",
- "path": "v1beta/apps/{appsId}/operations",
- "id": "appengine.apps.operations.list"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "appsId",
- "operationsId"
- ],
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The name of the operation resource.",
- "required": true,
- "type": "string"
- },
- "operationsId": {
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "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."
- }
- }
- },
- "locations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "httpMethod": "GET",
- "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": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- }
- },
- "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."
- },
- "get": {
- "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}",
- "path": "v1beta/apps/{appsId}/locations/{locationsId}",
- "id": "appengine.apps.locations.get",
- "description": "Get information about a location.",
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "appsId",
- "locationsId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "appsId": {
- "location": "path",
- "description": "Part of `name`. Resource name for the location.",
- "required": true,
- "type": "string"
- },
- "locationsId": {
- "location": "path",
- "description": "Part of `name`. See documentation of `appsId`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/appengine.admin",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
- }
- }
}
}
}
},
"parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "default": "true",
+ "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.",
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query"
},
"callback": {
@@ -909,7 +880,21 @@
"description": "JSONP",
"type": "string"
},
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
"alt": {
+ "description": "Data format for response.",
"default": "json",
"enum": [
"json",
@@ -922,12 +907,6 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response."
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
"location": "query"
},
"key": {
@@ -935,6 +914,11 @@
"description": "API key. Your API 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",
@@ -946,118 +930,20 @@
"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": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
- "AutomaticScaling": {
- "type": "object",
- "properties": {
- "minPendingLatency": {
- "type": "string",
- "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration"
- },
- "maxIdleInstances": {
- "description": "Maximum number of idle instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "requestUtilization": {
- "$ref": "RequestUtilization",
- "description": "Target scaling by request utilization."
- },
- "minIdleInstances": {
- "type": "integer",
- "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
- "format": "int32"
- },
- "maxTotalInstances": {
- "description": "Maximum number of instances that should be started to handle requests.",
- "format": "int32",
- "type": "integer"
- },
- "minTotalInstances": {
- "description": "Minimum number of instances that should be maintained for this version.",
- "format": "int32",
- "type": "integer"
- },
- "networkUtilization": {
- "description": "Target scaling by network usage.",
- "$ref": "NetworkUtilization"
- },
- "coolDownPeriod": {
- "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
- "format": "google-duration",
- "type": "string"
- },
- "maxConcurrentRequests": {
- "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
- "format": "int32",
- "type": "integer"
- },
- "maxPendingLatency": {
- "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
- "format": "google-duration",
- "type": "string"
- },
- "cpuUtilization": {
- "$ref": "CpuUtilization",
- "description": "Target scaling by CPU usage."
- },
- "diskUtilization": {
- "$ref": "DiskUtilization",
- "description": "Target scaling by disk usage."
- }
- },
- "id": "AutomaticScaling",
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
- },
- "ZipInfo": {
- "id": "ZipInfo",
- "description": "The zip file information for a zip deployment.",
- "type": "object",
- "properties": {
- "sourceUrl": {
- "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
- "type": "string"
- },
- "filesCount": {
- "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "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": {
"nextPageToken": {
@@ -1065,74 +951,46 @@
"type": "string"
},
"locations": {
- "description": "A list of locations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Location"
- }
+ },
+ "description": "A list of locations that matches the specified filter in the request."
}
},
- "id": "ListLocationsResponse",
- "description": "The response message for Locations.ListLocations."
+ "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": {
- "type": "string",
- "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\""
+ "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": {
- "id": "RequestUtilization",
"description": "Target scaling by request utilization. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetRequestCountPerSecond": {
- "description": "Target requests per second.",
- "format": "int32",
- "type": "integer"
- },
"targetConcurrentRequests": {
"description": "Target number of concurrent requests.",
"format": "int32",
"type": "integer"
+ },
+ "targetRequestCountPerSecond": {
+ "description": "Target requests per second.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "RequestUtilization"
},
"UrlMap": {
- "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
- "type": "object",
"properties": {
- "login": {
- "enum": [
- "LOGIN_UNSPECIFIED",
- "LOGIN_OPTIONAL",
- "LOGIN_ADMIN",
- "LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource.",
- "type": "string",
- "enumDescriptions": [
- "Not specified. LOGIN_OPTIONAL is assumed.",
- "Does not require that the user is signed in.",
- "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.",
- "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken."
- ]
- },
- "apiEndpoint": {
- "description": "Uses API Endpoints to handle requests.",
- "$ref": "ApiEndpointHandler"
- },
- "staticFiles": {
- "$ref": "StaticFilesHandler",
- "description": "Returns the contents of a file, such as an image, as the response."
- },
"redirectHttpResponseCode": {
- "type": "string",
"enumDescriptions": [
"Not specified. 302 is assumed.",
"301 Moved Permanently code.",
@@ -1147,7 +1005,8 @@
"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."
+ "description": "30x code to use when performing redirects for the secure field. Defaults to 302.",
+ "type": "string"
},
"securityLevel": {
"enum": [
@@ -1168,32 +1027,57 @@
]
},
"authFailAction": {
- "enum": [
- "AUTH_FAIL_ACTION_UNSPECIFIED",
- "AUTH_FAIL_ACTION_REDIRECT",
- "AUTH_FAIL_ACTION_UNAUTHORIZED"
- ],
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
"type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
"Rejects request with a 401 HTTP status code and an error message."
- ]
+ ],
+ "enum": [
+ "AUTH_FAIL_ACTION_UNSPECIFIED",
+ "AUTH_FAIL_ACTION_REDIRECT",
+ "AUTH_FAIL_ACTION_UNAUTHORIZED"
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect."
},
"script": {
- "$ref": "ScriptHandler",
- "description": "Executes a script to handle the request that matches this URL pattern."
+ "description": "Executes a script to handle the request that matches this URL pattern.",
+ "$ref": "ScriptHandler"
},
"urlRegex": {
- "type": "string",
- "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."
+ "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"
}
},
- "id": "UrlMap"
+ "id": "UrlMap",
+ "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.",
+ "type": "object"
},
"EndpointsApiService": {
- "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",
"properties": {
@@ -1205,12 +1089,25 @@
"description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"",
"type": "string"
}
- }
+ },
+ "id": "EndpointsApiService"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
+ "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.",
@@ -1226,33 +1123,20 @@
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
- "type": "object"
- },
- "done": {
- "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
- "type": "boolean"
}
},
"id": "Operation"
},
"ApiConfigHandler": {
+ "id": "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"
+ "type": "string",
+ "description": "URL to serve the endpoint at."
},
"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.",
@@ -1266,11 +1150,11 @@
"SECURE_NEVER",
"SECURE_OPTIONAL",
"SECURE_ALWAYS"
- ]
+ ],
+ "description": "Security (HTTPS) enforcement for this URL.",
+ "type": "string"
},
"authFailAction": {
- "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
- "type": "string",
"enumDescriptions": [
"Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.",
"Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.",
@@ -1280,13 +1164,17 @@
"AUTH_FAIL_ACTION_UNSPECIFIED",
"AUTH_FAIL_ACTION_REDIRECT",
"AUTH_FAIL_ACTION_UNAUTHORIZED"
- ]
+ ],
+ "description": "Action to take when users access resources that require authentication. Defaults to redirect.",
+ "type": "string"
},
"script": {
"description": "Path to the script from the application root directory.",
"type": "string"
},
"login": {
+ "description": "Level of login required to access this resource. Defaults to optional.",
+ "type": "string",
"enumDescriptions": [
"Not specified. LOGIN_OPTIONAL is assumed.",
"Does not require that the user is signed in.",
@@ -1298,15 +1186,11 @@
"LOGIN_OPTIONAL",
"LOGIN_ADMIN",
"LOGIN_REQUIRED"
- ],
- "description": "Level of login required to access this resource. Defaults to optional.",
- "type": "string"
+ ]
}
- },
- "id": "ApiConfigHandler"
+ }
},
"StaticFilesHandler": {
- "id": "StaticFilesHandler",
"description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.",
"type": "object",
"properties": {
@@ -1332,26 +1216,27 @@
"type": "string"
},
"httpHeaders": {
+ "description": "HTTP headers to use for all responses from these URLs.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "HTTP headers to use for all responses from these URLs.",
- "type": "object"
+ }
},
"applicationReadable": {
"description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.",
"type": "boolean"
}
- }
+ },
+ "id": "StaticFilesHandler"
},
"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": {
- "type": "integer",
"description": "Maximum number of instances to create for this version.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"idleTimeout": {
"description": "Duration of time after the last request that an instance must wait before the instance is shut down.",
@@ -1365,16 +1250,6 @@
"description": "Target scaling by disk usage. Only applicable for VM runtimes.",
"type": "object",
"properties": {
- "targetReadBytesPerSecond": {
- "description": "Target bytes read per second.",
- "format": "int32",
- "type": "integer"
- },
- "targetReadOpsPerSecond": {
- "description": "Target ops read per seconds.",
- "format": "int32",
- "type": "integer"
- },
"targetWriteOpsPerSecond": {
"description": "Target ops written per second.",
"format": "int32",
@@ -1384,12 +1259,21 @@
"description": "Target bytes written per second.",
"format": "int32",
"type": "integer"
+ },
+ "targetReadBytesPerSecond": {
+ "type": "integer",
+ "description": "Target bytes read per second.",
+ "format": "int32"
+ },
+ "targetReadOpsPerSecond": {
+ "description": "Target ops read per seconds.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "DiskUtilization"
},
"CpuUtilization": {
- "id": "CpuUtilization",
"description": "Target scaling by CPU usage.",
"type": "object",
"properties": {
@@ -1403,7 +1287,8 @@
"format": "double",
"type": "number"
}
- }
+ },
+ "id": "CpuUtilization"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which 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 purpose.\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.",
@@ -1421,11 +1306,11 @@
"details": {
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
},
"description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use."
}
@@ -1436,21 +1321,21 @@
"description": "Identity-Aware Proxy",
"type": "object",
"properties": {
+ "oauth2ClientSecretSha256": {
+ "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly",
+ "type": "string"
+ },
"enabled": {
- "type": "boolean",
- "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty."
+ "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": {
- "type": "string",
- "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"
+ "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"
}
},
"id": "IdentityAwareProxy"
@@ -1471,20 +1356,18 @@
"description": "Metadata for the given google.cloud.location.Location.",
"type": "object",
"properties": {
- "standardEnvironmentAvailable": {
- "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
- "type": "boolean"
- },
"flexibleEnvironmentAvailable": {
"description": "App Engine Flexible Environment is available in the given location.@OutputOnly",
"type": "boolean"
+ },
+ "standardEnvironmentAvailable": {
+ "description": "App Engine Standard Environment is available in the given location.@OutputOnly",
+ "type": "boolean"
}
},
"id": "LocationMetadata"
},
"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": {
"split": {
"description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.",
@@ -1499,7 +1382,9 @@
"type": "string"
}
},
- "id": "Service"
+ "id": "Service",
+ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.",
+ "type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
@@ -1521,30 +1406,30 @@
},
"OperationMetadata": {
"properties": {
- "operationType": {
- "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
- "type": "string"
- },
"insertTime": {
"description": "Timestamp that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "target": {
- "type": "string",
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly"
- },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
},
+ "target": {
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly",
+ "type": "string"
+ },
"method": {
- "type": "string",
- "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly"
+ "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly",
+ "type": "string"
},
"endTime": {
+ "type": "string",
"description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
+ "format": "google-datetime"
+ },
+ "operationType": {
+ "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly",
"type": "string"
}
},
@@ -1553,15 +1438,10 @@
"type": "object"
},
"ErrorHandler": {
+ "description": "Custom static error page to be served when an error occurs.",
+ "type": "object",
"properties": {
"errorCode": {
- "enumDescriptions": [
- "Not specified. ERROR_CODE_DEFAULT is assumed.",
- "All other error types.",
- "Application has exceeded a resource quota.",
- "Client blocked by the application's Denial of Service protection configuration.",
- "Deadline reached before the application responds."
- ],
"enum": [
"ERROR_CODE_UNSPECIFIED",
"ERROR_CODE_DEFAULT",
@@ -1570,7 +1450,14 @@
"ERROR_CODE_TIMEOUT"
],
"description": "Error condition this handler applies to.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified. ERROR_CODE_DEFAULT is assumed.",
+ "All other error types.",
+ "Application has exceeded a resource quota.",
+ "Client blocked by the application's Denial of Service protection configuration.",
+ "Deadline reached before the application responds."
+ ]
},
"mimeType": {
"description": "MIME type of file. Defaults to text/html.",
@@ -1581,34 +1468,32 @@
"type": "string"
}
},
- "id": "ErrorHandler",
- "description": "Custom static error page to be served when an error occurs.",
- "type": "object"
+ "id": "ErrorHandler"
},
"OperationMetadataV1": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
"warning": {
- "description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Durable messages that persist on every operation poll. @OutputOnly"
},
"insertTime": {
"description": "Time that this operation was created.@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "user": {
- "description": "User who requested this operation.@OutputOnly",
- "type": "string"
- },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
},
+ "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"
@@ -1625,66 +1510,16 @@
},
"id": "OperationMetadataV1"
},
- "Application": {
- "type": "object",
- "properties": {
- "dispatchRules": {
- "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly",
- "type": "array",
- "items": {
- "$ref": "UrlDispatchRule"
- }
- },
- "defaultHostname": {
- "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
- "type": "string"
- },
- "iap": {
- "$ref": "IdentityAwareProxy"
- },
- "authDomain": {
- "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
- "type": "string"
- },
- "defaultCookieExpiration": {
- "description": "Cookie expiration policy for this application.",
- "format": "google-duration",
- "type": "string"
- },
- "id": {
- "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
- "type": "string"
- },
- "codeBucket": {
- "description": "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": {
- "type": "string",
- "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly"
- },
- "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"
- }
- },
- "id": "Application",
- "description": "An Application resource contains the top-level configuration of an App Engine application."
- },
"Network": {
"description": "Extra network settings. Only applicable for VM runtimes.",
"type": "object",
"properties": {
"forwardedPorts": {
+ "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "List of ports, or port pairs, to forward from the virtual machine to the application container."
+ }
},
"instanceTag": {
"description": "Tag to apply to the VM instance during creation.",
@@ -1701,17 +1536,109 @@
},
"id": "Network"
},
+ "Application": {
+ "description": "An Application resource contains the top-level configuration of an App Engine application.",
+ "type": "object",
+ "properties": {
+ "iap": {
+ "$ref": "IdentityAwareProxy"
+ },
+ "authDomain": {
+ "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.",
+ "type": "string"
+ },
+ "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.@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "UrlDispatchRule"
+ }
+ },
+ "gcrDomain": {
+ "description": "The Google Container Registry domain used for storing managed build docker images for this application.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly",
+ "type": "string"
+ },
+ "defaultCookieExpiration": {
+ "description": "Cookie expiration policy for this application.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "id": {
+ "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US",
+ "type": "string"
+ },
+ "servingStatus": {
+ "type": "string",
+ "enumDescriptions": [
+ "Serving status is unspecified.",
+ "Application is serving.",
+ "Application has been disabled by the user.",
+ "Application has been disabled by the system."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "SERVING",
+ "USER_DISABLED",
+ "SYSTEM_DISABLED"
+ ],
+ "description": "Serving status of this application."
+ },
+ "defaultHostname": {
+ "description": "Hostname used to reach this application, as resolved by App Engine.@OutputOnly",
+ "type": "string"
+ }
+ },
+ "id": "Application"
+ },
"Instance": {
+ "id": "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"
+ },
+ "vmId": {
+ "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
+ "qps": {
+ "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
+ "format": "float",
+ "type": "number"
+ },
+ "name": {
+ "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
+ "type": "string"
+ },
+ "vmZoneName": {
+ "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
+ "type": "string"
+ },
"averageLatency": {
"description": "Average latency (ms) over the last minute.@OutputOnly",
"format": "int32",
"type": "integer"
},
- "id": {
- "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "vmIp": {
+ "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"memoryUsage": {
@@ -1719,41 +1646,41 @@
"format": "int64",
"type": "string"
},
- "vmIp": {
- "type": "string",
- "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly"
- },
- "availability": {
- "enum": [
- "UNSPECIFIED",
- "RESIDENT",
- "DYNAMIC"
- ],
- "description": "Availability of the instance.@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "",
- "",
- ""
- ]
+ "id": {
+ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly",
+ "type": "string"
},
"errors": {
"description": "Number of errors since this instance was started.@OutputOnly",
"format": "int32",
"type": "integer"
},
+ "availability": {
+ "description": "Availability of the instance.@OutputOnly",
+ "type": "string",
+ "enumDescriptions": [
+ "",
+ "",
+ ""
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "RESIDENT",
+ "DYNAMIC"
+ ]
+ },
"vmStatus": {
"description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
"type": "string"
},
"startTime": {
- "type": "string",
"description": "Time that this instance was started.@OutputOnly",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"vmDebugEnabled": {
- "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly"
},
"requests": {
"description": "Number of requests since this instance was started.@OutputOnly",
@@ -1763,58 +1690,16 @@
"appEngineRelease": {
"description": "App Engine release this instance is running on.@OutputOnly",
"type": "string"
- },
- "vmName": {
- "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "qps": {
- "description": "Average queries per second (QPS) over the last minute.@OutputOnly",
- "format": "float",
- "type": "number"
- },
- "vmId": {
- "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "vmZoneName": {
- "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly",
- "type": "string"
- },
- "name": {
- "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly",
- "type": "string"
}
- },
- "id": "Instance"
+ }
},
"LivenessCheck": {
"description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.",
"type": "object",
"properties": {
- "checkInterval": {
- "description": "Interval between health checks.",
- "format": "google-duration",
- "type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
- },
- "initialDelay": {
- "description": "The initial delay before starting to execute the checks.",
- "format": "google-duration",
- "type": "string"
- },
- "unhealthyThreshold": {
- "type": "integer",
- "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
- "format": "uint32"
- },
"path": {
- "description": "The request path.",
- "type": "string"
+ "type": "string",
+ "description": "The request path."
},
"host": {
"description": "Host header to send when performing a HTTP Liveness check. Example: \"myapp.appspot.com\"",
@@ -1824,6 +1709,26 @@
"description": "Number of consecutive successful checks required before considering the VM healthy.",
"format": "uint32",
"type": "integer"
+ },
+ "checkInterval": {
+ "type": "string",
+ "description": "Interval between health checks.",
+ "format": "google-duration"
+ },
+ "timeout": {
+ "type": "string",
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration"
+ },
+ "initialDelay": {
+ "description": "The initial delay before starting to execute the checks.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed checks required before considering the VM unhealthy.",
+ "format": "uint32",
+ "type": "integer"
}
},
"id": "LivenessCheck"
@@ -1833,9 +1738,9 @@
"type": "object",
"properties": {
"targetSentBytesPerSecond": {
- "type": "integer",
"description": "Target bytes sent per second.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"targetSentPacketsPerSecond": {
"description": "Target packets sent per second.",
@@ -1848,14 +1753,16 @@
"type": "integer"
},
"targetReceivedPacketsPerSecond": {
+ "type": "integer",
"description": "Target packets received per second.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
}
},
"id": "NetworkUtilization"
},
"Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
"properties": {
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"",
@@ -1869,8 +1776,8 @@
"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"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
}
},
"labels": {
@@ -1881,37 +1788,22 @@
"type": "object"
}
},
- "id": "Location",
- "description": "A resource that represents Google Cloud Platform location.",
- "type": "object"
+ "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": {
- "description": "Number of consecutive failed health checks required before removing traffic.",
+ "healthyThreshold": {
+ "description": "Number of consecutive successful health checks required before receiving traffic.",
"format": "uint32",
"type": "integer"
},
- "disableHealthCheck": {
- "description": "Whether to explicitly disable health checks for this instance.",
- "type": "boolean"
- },
- "host": {
- "type": "string",
- "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\""
- },
"restartThreshold": {
"description": "Number of consecutive failed health checks required before an instance is restarted.",
"format": "uint32",
"type": "integer"
},
- "healthyThreshold": {
- "description": "Number of consecutive successful health checks required before receiving traffic.",
- "format": "uint32",
- "type": "integer"
- },
"checkInterval": {
"description": "Interval between health checks.",
"format": "google-duration",
@@ -1921,14 +1813,30 @@
"description": "Time before the health check is considered failed.",
"format": "google-duration",
"type": "string"
+ },
+ "unhealthyThreshold": {
+ "description": "Number of consecutive failed health checks required before removing traffic.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "disableHealthCheck": {
+ "description": "Whether to explicitly disable health checks for this instance.",
+ "type": "boolean"
+ },
+ "host": {
+ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"",
+ "type": "string"
}
},
"id": "HealthCheck"
},
"ReadinessCheck": {
- "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
- "type": "object",
"properties": {
+ "timeout": {
+ "description": "Time before the check is considered failed.",
+ "format": "google-duration",
+ "type": "string"
+ },
"unhealthyThreshold": {
"description": "Number of consecutive failed checks required before removing traffic.",
"format": "uint32",
@@ -1951,30 +1859,36 @@
"description": "Interval between health checks.",
"format": "google-duration",
"type": "string"
- },
- "timeout": {
- "description": "Time before the check is considered failed.",
- "format": "google-duration",
- "type": "string"
}
},
- "id": "ReadinessCheck"
+ "id": "ReadinessCheck",
+ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.",
+ "type": "object"
},
"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": {
+ "insertTime": {
+ "description": "Timestamp that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "Timestamp that this operation completed.@OutputOnly",
+ "format": "google-datetime"
+ },
"user": {
"description": "User who requested this operation.@OutputOnly",
"type": "string"
@@ -1984,26 +1898,92 @@
"type": "string"
},
"method": {
- "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly",
- "type": "string"
- },
- "insertTime": {
- "description": "Timestamp that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "description": "Timestamp that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
+ "type": "string",
+ "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly"
}
},
- "id": "OperationMetadataV1Beta5"
+ "id": "OperationMetadataV1Beta5",
+ "description": "Metadata for the given google.longrunning.Operation."
},
"Version": {
"description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.",
"type": "object",
"properties": {
+ "versionUrl": {
+ "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
+ "type": "string"
+ },
+ "vm": {
+ "description": "Whether to deploy this version in a container on a virtual machine.",
+ "type": "boolean"
+ },
+ "instanceClass": {
+ "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
+ "type": "string"
+ },
+ "servingStatus": {
+ "enumDescriptions": [
+ "Not specified.",
+ "Currently serving. Instances are created according to the scaling settings of the version.",
+ "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING."
+ ],
+ "enum": [
+ "SERVING_STATUS_UNSPECIFIED",
+ "SERVING",
+ "STOPPED"
+ ],
+ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.",
+ "type": "string"
+ },
+ "deployment": {
+ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.",
+ "$ref": "Deployment"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "Time that this version was created.@OutputOnly",
+ "format": "google-datetime"
+ },
+ "resources": {
+ "$ref": "Resources",
+ "description": "Machine resources for this version. Only applicable for VM runtimes."
+ },
+ "inboundServices": {
+ "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "INBOUND_SERVICE_UNSPECIFIED",
+ "INBOUND_SERVICE_MAIL",
+ "INBOUND_SERVICE_MAIL_BOUNCE",
+ "INBOUND_SERVICE_XMPP_ERROR",
+ "INBOUND_SERVICE_XMPP_MESSAGE",
+ "INBOUND_SERVICE_XMPP_SUBSCRIBE",
+ "INBOUND_SERVICE_XMPP_PRESENCE",
+ "INBOUND_SERVICE_CHANNEL_PRESENCE",
+ "INBOUND_SERVICE_WARMUP"
+ ]
+ },
+ "enumDescriptions": [
+ "Not specified.",
+ "Allows an application to receive mail.",
+ "Allows an application to receive email-bound notifications.",
+ "Allows an application to receive error stanzas.",
+ "Allows an application to receive instant messages.",
+ "Allows an application to receive user subscription POSTs.",
+ "Allows an application to receive a user's chat presence.",
+ "Registers an application for notifications when a client connects or disconnects from a channel.",
+ "Enables warmup requests."
+ ]
+ },
+ "errorHandlers": {
+ "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
+ "type": "array",
+ "items": {
+ "$ref": "ErrorHandler"
+ }
+ },
"defaultExpiration": {
"description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.",
"format": "google-duration",
@@ -2021,21 +2001,21 @@
"type": "string"
},
"basicScaling": {
- "$ref": "BasicScaling",
- "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity."
+ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.",
+ "$ref": "BasicScaling"
},
"runtime": {
"description": "Desired runtime. Example: python27.",
"type": "string"
},
- "id": {
- "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".",
- "type": "string"
- },
"createdBy": {
"description": "Email address of the user who created this version.@OutputOnly",
"type": "string"
},
+ "id": {
+ "type": "string",
+ "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-\"."
+ },
"envVariables": {
"additionalProperties": {
"type": "string"
@@ -2044,34 +2024,34 @@
"type": "object"
},
"livenessCheck": {
- "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.",
- "$ref": "LivenessCheck"
+ "$ref": "LivenessCheck",
+ "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set."
},
"network": {
- "description": "Extra network settings. Only applicable for VM runtimes.",
- "$ref": "Network"
+ "$ref": "Network",
+ "description": "Extra network settings. Only applicable for VM runtimes."
},
"betaSettings": {
+ "description": "Metadata settings that are supplied to this version to enable beta runtime features.",
"type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Metadata settings that are supplied to this version to enable beta runtime features."
+ }
},
"env": {
"description": "App Engine execution environment for this version.Defaults to standard.",
"type": "string"
},
"handlers": {
+ "description": "An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.",
"type": "array",
"items": {
"$ref": "UrlMap"
- },
- "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."
+ }
},
"automaticScaling": {
- "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
- "$ref": "AutomaticScaling"
+ "$ref": "AutomaticScaling",
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics."
},
"diskUsageBytes": {
"description": "Total size in bytes of all the files that are included in this version and curerntly hosted on the App Engine disk.@OutputOnly",
@@ -2087,8 +2067,8 @@
"type": "boolean"
},
"readinessCheck": {
- "$ref": "ReadinessCheck",
- "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set."
+ "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.",
+ "$ref": "ReadinessCheck"
},
"manualScaling": {
"description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.",
@@ -2103,103 +2083,28 @@
"description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set."
},
"endpointsApiService": {
- "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.",
- "$ref": "EndpointsApiService"
- },
- "versionUrl": {
- "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly",
- "type": "string"
- },
- "vm": {
- "description": "Whether to deploy this version in a container on a virtual machine.",
- "type": "boolean"
- },
- "instanceClass": {
- "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.",
- "type": "string"
- },
- "servingStatus": {
- "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"
- ],
- "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."
- },
- "deployment": {
- "$ref": "Deployment",
- "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set."
- },
- "createTime": {
- "description": "Time that this version was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "resources": {
- "$ref": "Resources",
- "description": "Machine resources for this version. Only applicable for VM runtimes."
- },
- "inboundServices": {
- "enumDescriptions": [
- "Not specified.",
- "Allows an application to receive mail.",
- "Allows an application to receive email-bound notifications.",
- "Allows an application to receive error stanzas.",
- "Allows an application to receive instant messages.",
- "Allows an application to receive user subscription POSTs.",
- "Allows an application to receive a user's chat presence.",
- "Registers an application for notifications when a client connects or disconnects from a channel.",
- "Enables warmup requests."
- ],
- "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.",
- "type": "array",
- "items": {
- "enum": [
- "INBOUND_SERVICE_UNSPECIFIED",
- "INBOUND_SERVICE_MAIL",
- "INBOUND_SERVICE_MAIL_BOUNCE",
- "INBOUND_SERVICE_XMPP_ERROR",
- "INBOUND_SERVICE_XMPP_MESSAGE",
- "INBOUND_SERVICE_XMPP_SUBSCRIBE",
- "INBOUND_SERVICE_XMPP_PRESENCE",
- "INBOUND_SERVICE_CHANNEL_PRESENCE",
- "INBOUND_SERVICE_WARMUP"
- ],
- "type": "string"
- }
- },
- "errorHandlers": {
- "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.",
- "type": "array",
- "items": {
- "$ref": "ErrorHandler"
- }
+ "$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."
}
},
"id": "Version"
},
"RepairApplicationRequest": {
- "id": "RepairApplicationRequest",
"description": "Request message for 'Applications.RepairApplication'.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "RepairApplicationRequest"
},
"FileInfo": {
"type": "object",
"properties": {
"sha1Sum": {
- "type": "string",
- "description": "The SHA1 hash of the file, in hex."
+ "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"
+ "type": "string",
+ "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage."
},
"sourceUrl": {
"description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
@@ -2213,8 +2118,8 @@
"type": "object",
"properties": {
"scriptPath": {
- "description": "Path to the script from the application root directory.",
- "type": "string"
+ "type": "string",
+ "description": "Path to the script from the application root directory."
}
},
"id": "ScriptHandler",
@@ -2229,8 +2134,8 @@
"description": "User who requested this operation.@OutputOnly"
},
"target": {
- "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly",
- "type": "string"
+ "type": "string",
+ "description": "Name of the resource that this operation is acting on. Example: apps/myapp/customDomains/example.com.@OutputOnly"
},
"method": {
"description": "API method that initiated this operation. Example: google.appengine.experimental.CustomDomains.CreateCustomDomain.@OutputOnly",
@@ -2250,48 +2155,40 @@
"id": "OperationMetadataExperimental"
},
"TrafficSplit": {
- "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.",
"type": "object",
"properties": {
"shardBy": {
- "enumDescriptions": [
- "Diversion method unspecified.",
- "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
- "Diversion based on applying the modulus operation to a fingerprint of the IP address."
- ],
"enum": [
"UNSPECIFIED",
"COOKIE",
- "IP"
+ "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"
+ "type": "string",
+ "enumDescriptions": [
+ "Diversion method unspecified.",
+ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.",
+ "Diversion based on applying the modulus operation to a fingerprint of the IP address.",
+ "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share."
+ ]
},
"allocations": {
- "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": {
- "type": "number",
- "format": "double"
- }
+ "format": "double",
+ "type": "number"
+ },
+ "description": "Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.",
+ "type": "object"
}
},
- "id": "TrafficSplit"
+ "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."
},
"OperationMetadataV1Beta": {
"description": "Metadata for the given google.longrunning.Operation.",
"type": "object",
"properties": {
- "endTime": {
- "description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "insertTime": {
- "description": "Time that this operation was created.@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
"warning": {
"description": "Durable messages that persist on every operation poll. @OutputOnly",
"type": "array",
@@ -2299,6 +2196,11 @@
"type": "string"
}
},
+ "insertTime": {
+ "description": "Time that this operation was created.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
"target": {
"description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly",
"type": "string"
@@ -2314,6 +2216,11 @@
"method": {
"description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly",
"type": "string"
+ },
+ "endTime": {
+ "description": "Time that this operation completed.@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "OperationMetadataV1Beta"
@@ -2323,11 +2230,11 @@
"type": "object",
"properties": {
"services": {
+ "description": "The services belonging to the requested application.",
"type": "array",
"items": {
"$ref": "Service"
- },
- "description": "The services belonging to the requested application."
+ }
},
"nextPageToken": {
"description": "Continuation token for fetching the next page of results.",
@@ -2337,29 +2244,28 @@
"id": "ListServicesResponse"
},
"Deployment": {
+ "description": "Code and application artifacts used to deploy a version to App Engine.",
+ "type": "object",
"properties": {
"zip": {
- "description": "The zip file for this deployment, if this is a zip deployment.",
- "$ref": "ZipInfo"
+ "$ref": "ZipInfo",
+ "description": "The zip file for this deployment, if this is a zip deployment."
},
"container": {
- "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.",
- "$ref": "ContainerInfo"
+ "$ref": "ContainerInfo",
+ "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment."
},
"files": {
+ "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.",
+ "type": "object",
"additionalProperties": {
"$ref": "FileInfo"
- },
- "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"
+ "id": "Deployment"
},
"Resources": {
- "id": "Resources",
"description": "Machine resources for a version.",
"type": "object",
"properties": {
@@ -2385,11 +2291,10 @@
"format": "double",
"type": "number"
}
- }
+ },
+ "id": "Resources"
},
"Volume": {
- "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
- "type": "object",
"properties": {
"sizeGb": {
"description": "Volume size in gigabytes.",
@@ -2405,7 +2310,9 @@
"type": "string"
}
},
- "id": "Volume"
+ "id": "Volume",
+ "description": "Volumes mounted within the app container. Only applicable for VM runtimes.",
+ "type": "object"
},
"ListInstancesResponse": {
"description": "Response message for Instances.ListInstances.",
@@ -2429,14 +2336,14 @@
"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"
},
+ "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"
@@ -2446,9 +2353,9 @@
"type": "string"
},
"endTime": {
- "type": "string",
"description": "Time that this operation completed.@OutputOnly",
- "format": "google-datetime"
+ "format": "google-datetime",
+ "type": "string"
},
"insertTime": {
"description": "Time that this operation was created.@OutputOnly",
@@ -2466,9 +2373,14 @@
"id": "OperationMetadataV1Alpha"
},
"UrlDispatchRule": {
+ "id": "UrlDispatchRule",
"description": "Rules to match an HTTP request and dispatch that request to a service.",
"type": "object",
"properties": {
+ "path": {
+ "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
+ "type": "string"
+ },
"domain": {
"description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".",
"type": "string"
@@ -2476,13 +2388,8 @@
"service": {
"description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.",
"type": "string"
- },
- "path": {
- "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.",
- "type": "string"
}
- },
- "id": "UrlDispatchRule"
+ }
},
"ListVersionsResponse": {
"description": "Response message for Versions.ListVersions.",
@@ -2512,11 +2419,126 @@
}
},
"id": "ApiEndpointHandler"
+ },
+ "ZipInfo": {
+ "description": "The zip file information for a zip deployment.",
+ "type": "object",
+ "properties": {
+ "filesCount": {
+ "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUrl": {
+ "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.",
+ "type": "string"
+ }
+ },
+ "id": "ZipInfo"
+ },
+ "AutomaticScaling": {
+ "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.",
+ "type": "object",
+ "properties": {
+ "diskUtilization": {
+ "description": "Target scaling by disk usage.",
+ "$ref": "DiskUtilization"
+ },
+ "minPendingLatency": {
+ "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxIdleInstances": {
+ "description": "Maximum number of idle instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestUtilization": {
+ "$ref": "RequestUtilization",
+ "description": "Target scaling by request utilization."
+ },
+ "minIdleInstances": {
+ "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxTotalInstances": {
+ "description": "Maximum number of instances that should be started to handle requests.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "minTotalInstances": {
+ "description": "Minimum number of instances that should be maintained for this version.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "networkUtilization": {
+ "$ref": "NetworkUtilization",
+ "description": "Target scaling by network usage."
+ },
+ "coolDownPeriod": {
+ "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "maxConcurrentRequests": {
+ "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPendingLatency": {
+ "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cpuUtilization": {
+ "$ref": "CpuUtilization",
+ "description": "Target scaling by CPU usage."
+ }
+ },
+ "id": "AutomaticScaling"
+ },
+ "Library": {
+ "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",
+ "description": "Third-party Python runtime library that is required by the application."
}
},
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "protocol": "rest"
+ "protocol": "rest",
+ "version": "v1beta",
+ "baseUrl": "https://appengine.googleapis.com/",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/appengine.admin": {
+ "description": "View and manage your applications deployed on Google App Engine"
+ },
+ "https://www.googleapis.com/auth/cloud-platform.read-only": {
+ "description": "View your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Provisions and manages App Engine applications.",
+ "servicePath": "",
+ "rootUrl": "https://appengine.googleapis.com/"
}
diff --git a/appengine/v1beta/appengine-gen.go b/appengine/v1beta/appengine-gen.go
index fa0eed0..42a99c4 100644
--- a/appengine/v1beta/appengine-gen.go
+++ b/appengine/v1beta/appengine-gen.go
@@ -295,6 +295,10 @@
// are order-dependent.@OutputOnly
DispatchRules []*UrlDispatchRule `json:"dispatchRules,omitempty"`
+ // GcrDomain: The Google Container Registry domain used for storing
+ // managed build docker images for this application.
+ GcrDomain string `json:"gcrDomain,omitempty"`
+
Iap *IdentityAwareProxy `json:"iap,omitempty"`
// Id: Identifier of the Application resource. This identifier is
@@ -313,6 +317,15 @@
// apps/myapp.@OutputOnly
Name string `json:"name,omitempty"`
+ // ServingStatus: Serving status of this application.
+ //
+ // Possible values:
+ // "UNSPECIFIED" - Serving status is unspecified.
+ // "SERVING" - Application is serving.
+ // "USER_DISABLED" - Application has been disabled by the user.
+ // "SYSTEM_DISABLED" - Application has been disabled by the system.
+ ServingStatus string `json:"servingStatus,omitempty"`
+
// ServerResponse contains the HTTP response code and headers from the
// server.
googleapi.ServerResponse `json:"-"`
@@ -2184,6 +2197,9 @@
// diversion will occur.
// "IP" - Diversion based on applying the modulus operation to a
// fingerprint of the IP address.
+ // "RANDOM" - 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.
ShardBy string `json:"shardBy,omitempty"`
// ForceSendFields is a list of field names (e.g. "Allocations") to
@@ -5956,7 +5972,10 @@
header_ http.Header
}
-// List: Lists the instances of a version.
+// List: 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.timeS
+// eries/list).
func (r *AppsServicesVersionsInstancesService) List(appsId string, servicesId string, versionsId string) *AppsServicesVersionsInstancesListCall {
c := &AppsServicesVersionsInstancesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.appsId = appsId
@@ -6076,7 +6095,7 @@
}
return ret, nil
// {
- // "description": "Lists the instances of a version.",
+ // "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).",
// "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances",
// "httpMethod": "GET",
// "id": "appengine.apps.services.versions.instances.list",
diff --git a/cloudbilling/v1/cloudbilling-api.json b/cloudbilling/v1/cloudbilling-api.json
index 6559ad3..5417efe 100644
--- a/cloudbilling/v1/cloudbilling-api.json
+++ b/cloudbilling/v1/cloudbilling-api.json
@@ -1,343 +1,357 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/M2VzqGfwqR0FviWkPggfCzE5zZU\"",
- "discoveryVersion": "v1",
- "id": "cloudbilling:v1",
- "name": "cloudbilling",
- "version": "v1",
- "revision": "20151222",
- "title": "Google Cloud Billing API",
- "description": "Retrieves Google Developers Console billing accounts and associates them with projects.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://cloud.google.com/billing/",
- "protocol": "rest",
- "baseUrl": "https://cloudbilling.googleapis.com/",
- "basePath": "",
- "rootUrl": "https://cloudbilling.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "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.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- }
- }
- }
- },
- "schemas": {
- "BillingAccount": {
- "id": "BillingAccount",
- "type": "object",
- "description": "A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`."
- },
- "open": {
- "type": "boolean",
- "description": "True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services."
- },
- "displayName": {
- "type": "string",
- "description": "The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console."
- }
- }
- },
- "ListBillingAccountsResponse": {
- "id": "ListBillingAccountsResponse",
- "type": "object",
- "description": "Response message for `ListBillingAccounts`.",
- "properties": {
- "billingAccounts": {
- "type": "array",
- "description": "A list of billing accounts.",
- "items": {
- "$ref": "BillingAccount"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve."
- }
- }
- },
- "ListProjectBillingInfoResponse": {
- "id": "ListProjectBillingInfoResponse",
- "type": "object",
- "description": "Request message for `ListProjectBillingInfoResponse`.",
- "properties": {
- "projectBillingInfo": {
- "type": "array",
- "description": "A list of `ProjectBillingInfo` resources representing the projects associated with the billing account.",
- "items": {
- "$ref": "ProjectBillingInfo"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve the next page of results. To retrieve the next page, call `ListProjectBillingInfo` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve."
- }
- }
- },
- "ProjectBillingInfo": {
- "id": "ProjectBillingInfo",
- "type": "object",
- "description": "Encapsulation of billing information for a Developers Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).",
- "properties": {
- "name": {
- "type": "string",
- "description": "The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only."
- },
- "projectId": {
- "type": "string",
- "description": "The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only."
- },
- "billingAccountName": {
- "type": "string",
- "description": "The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`."
- },
- "billingEnabled": {
- "type": "boolean",
- "description": "True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only."
- }
- }
- }
- },
- "resources": {
- "billingAccounts": {
- "methods": {
- "get": {
- "id": "cloudbilling.billingAccounts.get",
- "path": "v1/{+name}",
- "httpMethod": "GET",
- "description": "Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "pattern": "^billingAccounts/[^/]*$",
- "location": "path"
- }
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "BillingAccount"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "id": "cloudbilling.billingAccounts.list",
- "path": "v1/billingAccounts",
- "httpMethod": "GET",
- "description": "Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "pageSize": {
- "type": "integer",
- "description": "Requested page size. The maximum page size is 100; this is also the default.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListBillingAccountsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "list": {
- "id": "cloudbilling.billingAccounts.projects.list",
- "path": "v1/{+name}/projects",
- "httpMethod": "GET",
- "description": "Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
- "required": true,
- "pattern": "^billingAccounts/[^/]*$",
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Requested page size. The maximum page size is 100; this is also the default.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.",
- "location": "query"
+ "id": "cloudbilling:v1",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListProjectBillingInfoResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
- }
}
- }
},
- "projects": {
- "methods": {
- "getBillingInfo": {
- "id": "cloudbilling.projects.getBillingInfo",
- "path": "v1/{+name}/billingInfo",
- "httpMethod": "GET",
- "description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "pattern": "^projects/[^/]*$",
- "location": "path"
+ "description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
+ "protocol": "rest",
+ "title": "Google Cloud Billing API",
+ "resources": {
+ "projects": {
+ "methods": {
+ "updateBillingInfo": {
+ "id": "cloudbilling.projects.updateBillingInfo",
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
+ "request": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "flatPath": "v1/projects/{projectsId}/billingInfo",
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/billingInfo",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "getBillingInfo": {
+ "id": "cloudbilling.projects.getBillingInfo",
+ "response": {
+ "$ref": "ProjectBillingInfo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).",
+ "flatPath": "v1/projects/{projectsId}/billingInfo",
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
+ "required": true,
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/billingInfo",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
}
- },
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
},
- "updateBillingInfo": {
- "id": "cloudbilling.projects.updateBillingInfo",
- "path": "v1/{+name}/billingInfo",
- "httpMethod": "PUT",
- "description": "Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.",
- "parameters": {
- "name": {
- "type": "string",
- "description": "The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`.",
- "required": true,
- "pattern": "^projects/[^/]*$",
- "location": "path"
+ "billingAccounts": {
+ "resources": {
+ "projects": {
+ "methods": {
+ "list": {
+ "id": "cloudbilling.billingAccounts.projects.list",
+ "response": {
+ "$ref": "ListProjectBillingInfoResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "description": "Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
+ "location": "query",
+ "type": "integer",
+ "format": "int32"
+ },
+ "name": {
+ "description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}/projects",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ },
+ "methods": {
+ "get": {
+ "id": "cloudbilling.billingAccounts.get",
+ "response": {
+ "$ref": "BillingAccount"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
+ "flatPath": "v1/billingAccounts/{billingAccountsId}",
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
+ "required": true,
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "id": "cloudbilling.billingAccounts.list",
+ "response": {
+ "$ref": "ListBillingAccountsResponse"
+ },
+ "parameterOrder": [],
+ "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).",
+ "flatPath": "v1/billingAccounts",
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
+ "location": "query",
+ "type": "integer",
+ "format": "int32"
+ },
+ "pageToken": {
+ "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/billingAccounts",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
}
- },
- "parameterOrder": [
- "name"
- ],
- "request": {
- "$ref": "ProjectBillingInfo"
- },
- "response": {
- "$ref": "ProjectBillingInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
}
- }
- }
- }
+ },
+ "schemas": {
+ "ProjectBillingInfo": {
+ "description": "Encapsulation of billing information for a Cloud Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
+ "type": "object",
+ "properties": {
+ "billingEnabled": {
+ "description": "True if the project is associated with an open billing account, to which\nusage on the project is charged. False if the project is associated with a\nclosed billing account, or no billing account at all, and therefore cannot\nuse paid services. This field is read-only.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The resource name for the `ProjectBillingInfo`; has the form\n`projects/{project_id}/billingInfo`. For example, the resource name for the\nbilling information for project `tokyo-rain-123` would be\n`projects/tokyo-rain-123/billingInfo`. This field is read-only.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the project that this `ProjectBillingInfo` represents, such as\n`tokyo-rain-123`. This is a convenience field so that you don't need to\nparse the `name` field to obtain a project ID. This field is read-only.",
+ "type": "string"
+ },
+ "billingAccountName": {
+ "description": "The resource name of the billing account associated with the project, if\nany. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ "type": "string"
+ }
+ },
+ "id": "ProjectBillingInfo"
+ },
+ "ListProjectBillingInfoResponse": {
+ "description": "Request message for `ListProjectBillingInfoResponse`.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListProjectBillingInfo` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ },
+ "projectBillingInfo": {
+ "description": "A list of `ProjectBillingInfo` resources representing the projects\nassociated with the billing account.",
+ "type": "array",
+ "items": {
+ "$ref": "ProjectBillingInfo"
+ }
+ }
+ },
+ "id": "ListProjectBillingInfoResponse"
+ },
+ "ListBillingAccountsResponse": {
+ "description": "Response message for `ListBillingAccounts`.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
+ "type": "string"
+ },
+ "billingAccounts": {
+ "description": "A list of billing accounts.",
+ "type": "array",
+ "items": {
+ "$ref": "BillingAccount"
+ }
+ }
+ },
+ "id": "ListBillingAccountsResponse"
+ },
+ "BillingAccount": {
+ "description": "A billing account in [Google Cloud\nConsole](https://console.cloud.google.com/). You can assign a billing account\nto one or more projects.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The display name given to the billing account, such as `My Billing\nAccount`. This name is displayed in the Google Cloud Console.",
+ "type": "string"
+ },
+ "open": {
+ "description": "True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The resource name of the billing account. The resource name has the form\n`billingAccounts/{billing_account_id}`. For example,\n`billingAccounts/012345-567890-ABCDEF` would be the resource name for\nbilling account `012345-567890-ABCDEF`.",
+ "type": "string"
+ }
+ },
+ "id": "BillingAccount"
+ }
+ },
+ "revision": "20170210",
+ "basePath": "",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "discoveryVersion": "v1",
+ "baseUrl": "https://cloudbilling.googleapis.com/",
+ "name": "cloudbilling",
+ "parameters": {
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "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"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "location": "query",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "default": "json",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "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"
+ }
+ },
+ "documentationLink": "https://cloud.google.com/billing/",
+ "ownerDomain": "google.com",
+ "batchPath": "batch",
+ "servicePath": "",
+ "ownerName": "Google",
+ "version": "v1",
+ "rootUrl": "https://cloudbilling.googleapis.com/",
+ "kind": "discovery#restDescription"
}
diff --git a/cloudbilling/v1/cloudbilling-gen.go b/cloudbilling/v1/cloudbilling-gen.go
index 91cd415..505e693 100644
--- a/cloudbilling/v1/cloudbilling-gen.go
+++ b/cloudbilling/v1/cloudbilling-gen.go
@@ -113,25 +113,32 @@
s *Service
}
-// BillingAccount: A billing account in [Google Developers
-// Console](https://console.developers.google.com/). You can assign a
-// billing account to one or more projects.
+// BillingAccount: A billing account in [Google
+// Cloud
+// Console](https://console.cloud.google.com/). You can assign a billing
+// account
+// to one or more projects.
type BillingAccount struct {
// DisplayName: The display name given to the billing account, such as
- // `My Billing Account`. This name is displayed in the Google Developers
- // Console.
+ // `My Billing
+ // Account`. This name is displayed in the Google Cloud Console.
DisplayName string `json:"displayName,omitempty"`
// Name: The resource name of the billing account. The resource name has
- // the form `billingAccounts/{billing_account_id}`. For example,
- // `billingAccounts/012345-567890-ABCDEF` would be the resource name for
+ // the form
+ // `billingAccounts/{billing_account_id}`. For
+ // example,
+ // `billingAccounts/012345-567890-ABCDEF` would be the resource name
+ // for
// billing account `012345-567890-ABCDEF`.
Name string `json:"name,omitempty"`
// Open: True if the billing account is open, and will therefore be
- // charged for any usage on associated projects. False if the billing
- // account is closed, and therefore projects associated with it will be
- // unable to use paid services.
+ // charged for any
+ // usage on associated projects. False if the billing account is closed,
+ // and
+ // therefore projects associated with it will be unable to use paid
+ // services.
Open bool `json:"open,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -168,9 +175,10 @@
BillingAccounts []*BillingAccount `json:"billingAccounts,omitempty"`
// NextPageToken: A token to retrieve the next page of results. To
- // retrieve the next page, call `ListBillingAccounts` again with the
- // `page_token` field set to this value. This field is empty if there
- // are no more results to retrieve.
+ // retrieve the next page,
+ // call `ListBillingAccounts` again with the `page_token` field set to
+ // this
+ // value. This field is empty if there are no more results to retrieve.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -205,13 +213,15 @@
// `ListProjectBillingInfoResponse`.
type ListProjectBillingInfoResponse struct {
// NextPageToken: A token to retrieve the next page of results. To
- // retrieve the next page, call `ListProjectBillingInfo` again with the
- // `page_token` field set to this value. This field is empty if there
- // are no more results to retrieve.
+ // retrieve the next page,
+ // call `ListProjectBillingInfo` again with the `page_token` field set
+ // to this
+ // value. This field is empty if there are no more results to retrieve.
NextPageToken string `json:"nextPageToken,omitempty"`
// ProjectBillingInfo: A list of `ProjectBillingInfo` resources
- // representing the projects associated with the billing account.
+ // representing the projects
+ // associated with the billing account.
ProjectBillingInfo []*ProjectBillingInfo `json:"projectBillingInfo,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -241,33 +251,41 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ProjectBillingInfo: Encapsulation of billing information for a
-// Developers Console project. A project has at most one associated
-// billing account at a time (but a billing account can be assigned to
-// multiple projects).
+// ProjectBillingInfo: Encapsulation of billing information for a Cloud
+// Console project. A project
+// has at most one associated billing account at a time (but a billing
+// account
+// can be assigned to multiple projects).
type ProjectBillingInfo struct {
// BillingAccountName: The resource name of the billing account
- // associated with the project, if any. For example,
- // `billingAccounts/012345-567890-ABCDEF`.
+ // associated with the project, if
+ // any. For example, `billingAccounts/012345-567890-ABCDEF`.
BillingAccountName string `json:"billingAccountName,omitempty"`
// BillingEnabled: True if the project is associated with an open
- // billing account, to which usage on the project is charged. False if
- // the project is associated with a closed billing account, or no
- // billing account at all, and therefore cannot use paid services. This
- // field is read-only.
+ // billing account, to which
+ // usage on the project is charged. False if the project is associated
+ // with a
+ // closed billing account, or no billing account at all, and therefore
+ // cannot
+ // use paid services. This field is read-only.
BillingEnabled bool `json:"billingEnabled,omitempty"`
- // Name: The resource name for the `ProjectBillingInfo`; has the form
+ // Name: The resource name for the `ProjectBillingInfo`; has the
+ // form
// `projects/{project_id}/billingInfo`. For example, the resource name
- // for the billing information for project `tokyo-rain-123` would be
+ // for the
+ // billing information for project `tokyo-rain-123` would
+ // be
// `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Name string `json:"name,omitempty"`
// ProjectId: The ID of the project that this `ProjectBillingInfo`
- // represents, such as `tokyo-rain-123`. This is a convenience field so
- // that you don't need to parse the `name` field to obtain a project ID.
- // This field is read-only.
+ // represents, such as
+ // `tokyo-rain-123`. This is a convenience field so that you don't need
+ // to
+ // parse the `name` field to obtain a project ID. This field is
+ // read-only.
ProjectId string `json:"projectId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -310,7 +328,9 @@
}
// Get: Gets information about a billing account. The current
-// authenticated user must be an [owner of the billing
+// authenticated user
+// must be an [owner of the
+// billing
// account](https://support.google.com/cloud/answer/4430947).
func (r *BillingAccountsService) Get(name string) *BillingAccountsGetCall {
c := &BillingAccountsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -413,7 +433,8 @@
}
return ret, nil
// {
- // "description": "Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.get",
// "parameterOrder": [
@@ -421,9 +442,9 @@
// ],
// "parameters": {
// "name": {
- // "description": "The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ // "description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
// "location": "path",
- // "pattern": "^billingAccounts/[^/]*$",
+ // "pattern": "^billingAccounts/[^/]+$",
// "required": true,
// "type": "string"
// }
@@ -449,7 +470,8 @@
header_ http.Header
}
-// List: Lists the billing accounts that the current authenticated user
+// List: Lists the billing accounts that the current authenticated
+// user
// [owns](https://support.google.com/cloud/answer/4430947).
func (r *BillingAccountsService) List() *BillingAccountsListCall {
c := &BillingAccountsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -457,17 +479,19 @@
}
// PageSize sets the optional parameter "pageSize": Requested page size.
-// The maximum page size is 100; this is also the default.
+// The maximum page size is 100; this is also the
+// default.
func (c *BillingAccountsListCall) PageSize(pageSize int64) *BillingAccountsListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results to return. This should be a
+// identifying a page of results to return. This should be
+// a
// `next_page_token` value returned from a previous
-// `ListBillingAccounts` call. If unspecified, the first page of results
-// is returned.
+// `ListBillingAccounts`
+// call. If unspecified, the first page of results is returned.
func (c *BillingAccountsListCall) PageToken(pageToken string) *BillingAccountsListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -565,18 +589,20 @@
}
return ret, nil
// {
- // "description": "Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).",
+ // "flatPath": "v1/billingAccounts",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.list",
+ // "parameterOrder": [],
// "parameters": {
// "pageSize": {
- // "description": "Requested page size. The maximum page size is 100; this is also the default.",
+ // "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.",
+ // "description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
// "location": "query",
// "type": "string"
// }
@@ -625,7 +651,9 @@
}
// List: Lists the projects associated with a billing account. The
-// current authenticated user must be an [owner of the billing
+// current
+// authenticated user must be an [owner of the
+// billing
// account](https://support.google.com/cloud/answer/4430947).
func (r *BillingAccountsProjectsService) List(name string) *BillingAccountsProjectsListCall {
c := &BillingAccountsProjectsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -634,17 +662,19 @@
}
// PageSize sets the optional parameter "pageSize": Requested page size.
-// The maximum page size is 100; this is also the default.
+// The maximum page size is 100; this is also the
+// default.
func (c *BillingAccountsProjectsListCall) PageSize(pageSize int64) *BillingAccountsProjectsListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results to be returned. This should be a
+// identifying a page of results to be returned. This should be
+// a
// `next_page_token` value returned from a previous
-// `ListProjectBillingInfo` call. If unspecified, the first page of
-// results is returned.
+// `ListProjectBillingInfo`
+// call. If unspecified, the first page of results is returned.
func (c *BillingAccountsProjectsListCall) PageToken(pageToken string) *BillingAccountsProjectsListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -745,7 +775,8 @@
}
return ret, nil
// {
- // "description": "Lists the projects associated with a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).",
+ // "description": "Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
+ // "flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
// "httpMethod": "GET",
// "id": "cloudbilling.billingAccounts.projects.list",
// "parameterOrder": [
@@ -753,20 +784,20 @@
// ],
// "parameters": {
// "name": {
- // "description": "The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
+ // "description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
// "location": "path",
- // "pattern": "^billingAccounts/[^/]*$",
+ // "pattern": "^billingAccounts/[^/]+$",
// "required": true,
// "type": "string"
// },
// "pageSize": {
- // "description": "Requested page size. The maximum page size is 100; this is also the default.",
+ // "description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous `ListProjectBillingInfo` call. If unspecified, the first page of results is returned.",
+ // "description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
// "location": "query",
// "type": "string"
// }
@@ -815,9 +846,12 @@
}
// GetBillingInfo: Gets the billing information for a project. The
-// current authenticated user must have [permission to view the
-// project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxof
-// vnoo ).
+// current authenticated user
+// must have [permission to view
+// the
+// project](https://cloud.google.com/docs/permissions-overview#h.bgs0
+// oxofvnoo
+// ).
func (r *ProjectsService) GetBillingInfo(name string) *ProjectsGetBillingInfoCall {
c := &ProjectsGetBillingInfoCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -919,7 +953,8 @@
}
return ret, nil
// {
- // "description": "Gets the billing information for a project. The current authenticated user must have [permission to view the project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ).",
+ // "description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).",
+ // "flatPath": "v1/projects/{projectsId}/billingInfo",
// "httpMethod": "GET",
// "id": "cloudbilling.projects.getBillingInfo",
// "parameterOrder": [
@@ -927,9 +962,9 @@
// ],
// "parameters": {
// "name": {
- // "description": "The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`.",
+ // "description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
// "location": "path",
- // "pattern": "^projects/[^/]*$",
+ // "pattern": "^projects/[^/]+$",
// "required": true,
// "type": "string"
// }
@@ -957,33 +992,61 @@
}
// UpdateBillingInfo: Sets or updates the billing account associated
-// with a project. You specify the new billing account by setting the
-// `billing_account_name` in the `ProjectBillingInfo` resource to the
-// resource name of a billing account. Associating a project with an
-// open billing account enables billing on the project and allows
-// charges for resource usage. If the project already had a billing
-// account, this method changes the billing account used for resource
-// usage charges. *Note:* Incurred charges that have not yet been
-// reported in the transaction history of the Google Developers Console
-// may be billed to the new billing account, even if the charge occurred
-// before the new billing account was assigned to the project. The
-// current authenticated user must have ownership privileges for both
+// with a project. You specify
+// the new billing account by setting the `billing_account_name` in
// the
-// [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxo
-// fvnoo ) and the [billing
-// account](https://support.google.com/cloud/answer/4430947). You can
-// disable billing on the project by setting the `billing_account_name`
-// field to empty. This action disassociates the current billing account
-// from the project. Any billable activity of your in-use services will
-// stop, and your application could stop functioning as expected. Any
-// unbilled charges to date will be billed to the previously associated
-// account. The current authenticated user must be either an owner of
-// the project or an owner of the billing account for the project. Note
-// that associating a project with a *closed* billing account will have
-// much the same effect as disabling billing on the project: any paid
+// `ProjectBillingInfo` resource to the resource name of a billing
+// account.
+// Associating a project with an open billing account enables billing on
+// the
+// project and allows charges for resource usage. If the project already
+// had a
+// billing account, this method changes the billing account used for
+// resource
+// usage charges.
+//
+// *Note:* Incurred charges that have not yet been reported in the
+// transaction
+// history of the Google Cloud Console may be billed to the new
+// billing
+// account, even if the charge occurred before the new billing account
+// was
+// assigned to the project.
+//
+// The current authenticated user must have ownership privileges for
+// both
+// the
+// [project](https://cloud.google.com/docs/permissions-overview#h.bgs
+// 0oxofvnoo
+// ) and the
+// [billing
+// account](https://support.google.com/cloud/answer/4430947).
+//
+// Y
+// ou can disable billing on the project by setting
+// the
+// `billing_account_name` field to empty. This action disassociates
+// the
+// current billing account from the project. Any billable activity of
+// your
+// in-use services will stop, and your application could stop
+// functioning as
+// expected. Any unbilled charges to date will be billed to the
+// previously
+// associated account. The current authenticated user must be either an
+// owner
+// of the project or an owner of the billing account for the
+// project.
+//
+// Note that associating a project with a *closed* billing account will
+// have
+// much the same effect as disabling billing on the project: any
+// paid
// resources used by the project will be shut down. Thus, unless you
-// wish to disable billing, you should always call this method with the
-// name of an *open* billing account.
+// wish to
+// disable billing, you should always call this method with the name of
+// an
+// *open* billing account.
func (r *ProjectsService) UpdateBillingInfo(name string, projectbillinginfo *ProjectBillingInfo) *ProjectsUpdateBillingInfoCall {
c := &ProjectsUpdateBillingInfoCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -1078,7 +1141,8 @@
}
return ret, nil
// {
- // "description": "Sets or updates the billing account associated with a project. You specify the new billing account by setting the `billing_account_name` in the `ProjectBillingInfo` resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges. *Note:* Incurred charges that have not yet been reported in the transaction history of the Google Developers Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project. The current authenticated user must have ownership privileges for both the [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://support.google.com/cloud/answer/4430947). You can disable billing on the project by setting the `billing_account_name` field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project. Note that associating a project with a *closed* billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an *open* billing account.",
+ // "description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
+ // "flatPath": "v1/projects/{projectsId}/billingInfo",
// "httpMethod": "PUT",
// "id": "cloudbilling.projects.updateBillingInfo",
// "parameterOrder": [
@@ -1086,9 +1150,9 @@
// ],
// "parameters": {
// "name": {
- // "description": "The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`.",
+ // "description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
// "location": "path",
- // "pattern": "^projects/[^/]*$",
+ // "pattern": "^projects/[^/]+$",
// "required": true,
// "type": "string"
// }
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json
index 167cc4f..f22c4b7 100644
--- a/cloudbuild/v1/cloudbuild-api.json
+++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,4 +1,490 @@
{
+ "title": "Google Cloud Container Builder 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.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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`."
+ },
+ "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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations",
+ "path": "v1/{+name}",
+ "id": "cloudbuild.operations.list"
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "cloudbuild.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "triggers": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "triggerId": {
+ "description": "ID of the BuildTrigger to delete.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "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."
+ },
+ "get": {
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.get",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "description": "Gets information about a BuildTrigger.\n\nThis API is experimental."
+ },
+ "list": {
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.list",
+ "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBuildTriggersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project for which to list BuildTriggers.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/triggers"
+ },
+ "patch": {
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameterOrder": [
+ "projectId",
+ "triggerId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "triggerId": {
+ "location": "path",
+ "description": "ID of the BuildTrigger to update.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "ID of the project that owns the trigger.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
+ "path": "v1/projects/{projectId}/triggers/{triggerId}",
+ "id": "cloudbuild.projects.triggers.patch",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental."
+ },
+ "create": {
+ "response": {
+ "$ref": "BuildTrigger"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project for which to configure automatic builds.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/triggers",
+ "path": "v1/projects/{projectId}/triggers",
+ "id": "cloudbuild.projects.triggers.create",
+ "request": {
+ "$ref": "BuildTrigger"
+ },
+ "description": "Creates a new BuildTrigger.\n\nThis API is experimental."
+ }
+ }
+ },
+ "builds": {
+ "methods": {
+ "cancel": {
+ "description": "Cancels a requested build in progress.",
+ "request": {
+ "$ref": "CancelBuildRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "response": {
+ "$ref": "Build"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ },
+ "id": {
+ "location": "path",
+ "description": "ID of the build.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
+ "id": "cloudbuild.projects.builds.cancel",
+ "path": "v1/projects/{projectId}/builds/{id}:cancel"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Build"
+ },
+ "parameterOrder": [
+ "projectId",
+ "id"
+ ],
+ "parameters": {
+ "id": {
+ "description": "ID of the build.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds/{id}",
+ "id": "cloudbuild.projects.builds.get",
+ "path": "v1/projects/{projectId}/builds/{id}",
+ "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListBuildsResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Token to provide to skip to a particular spot in the list.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Number of results to return in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "The raw filter text to constrain the results.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.list",
+ "path": "v1/projects/{projectId}/builds",
+ "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "ID of the project.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/builds",
+ "id": "cloudbuild.projects.builds.create",
+ "path": "v1/projects/{projectId}/builds",
+ "request": {
+ "$ref": "Build"
+ },
+ "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure)."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "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://cloudbuild.googleapis.com/",
+ "description": "Builds container images in the cloud.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
"basePath": "",
"revision": "20170306",
"documentationLink": "https://cloud.google.com/container-builder/docs/",
@@ -7,6 +493,8 @@
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
@@ -29,9 +517,7 @@
"type": "string"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 `{}`.",
@@ -43,25 +529,6 @@
"description": "Configuration for an automated build in response to source repository\nchanges.",
"type": "object",
"properties": {
- "id": {
- "description": "Unique identifier of the trigger.\n\n@OutputOnly",
- "type": "string"
- },
- "build": {
- "description": "Contents of the build template.",
- "$ref": "Build"
- },
- "substitutions": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource."
- },
- "description": {
- "description": "Human-readable description of this trigger.",
- "type": "string"
- },
"disabled": {
"description": "If true, the trigger will never result in a build.",
"type": "boolean"
@@ -76,23 +543,42 @@
"description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build."
},
"filename": {
- "type": "string",
- "description": "Path, from the source root, to a file whose contents is used for the\ntemplate."
+ "description": "Path, from the source root, to a file whose contents is used for the\ntemplate.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier of the trigger.\n\n@OutputOnly",
+ "type": "string"
+ },
+ "build": {
+ "description": "Contents of the build template.",
+ "$ref": "Build"
+ },
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
+ "description": {
+ "description": "Human-readable description of this trigger.",
+ "type": "string"
}
},
"id": "BuildTrigger"
},
"Build": {
- "id": "Build",
- "description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.",
- "type": "object",
"properties": {
- "projectId": {
- "type": "string",
- "description": "ID of the project.\n@OutputOnly."
+ "images": {
+ "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
},
- "logUrl": {
- "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
+ "projectId": {
+ "description": "ID of the project.\n@OutputOnly.",
"type": "string"
},
"finishTime": {
@@ -100,9 +586,13 @@
"format": "google-datetime",
"type": "string"
},
+ "logUrl": {
+ "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly",
+ "type": "string"
+ },
"options": {
- "$ref": "BuildOptions",
- "description": "Special options for this build."
+ "description": "Special options for this build.",
+ "$ref": "BuildOptions"
},
"source": {
"$ref": "Source",
@@ -138,8 +628,8 @@
]
},
"statusDetail": {
- "type": "string",
- "description": "Customer-readable message about the current status.\n@OutputOnly"
+ "description": "Customer-readable message about the current status.\n@OutputOnly",
+ "type": "string"
},
"results": {
"$ref": "Results",
@@ -150,11 +640,11 @@
"type": "string"
},
"steps": {
+ "description": "Describes the operations to be performed on the workspace.",
"type": "array",
"items": {
"$ref": "BuildStep"
- },
- "description": "Describes the operations to be performed on the workspace."
+ }
},
"buildTriggerId": {
"description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly",
@@ -164,41 +654,37 @@
"description": "Unique identifier of the build.\n@OutputOnly",
"type": "string"
},
+ "substitutions": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Substitutions data for Build resource.",
+ "type": "object"
+ },
"startTime": {
"description": "Time at which execution of the build was started.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "substitutions": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Substitutions data for Build resource."
- },
- "sourceProvenance": {
- "description": "A permanent fixed identifier for source.\n@OutputOnly",
- "$ref": "SourceProvenance"
- },
"createTime": {
"description": "Time at which the request to create the build was received.\n@OutputOnly",
"format": "google-datetime",
"type": "string"
},
- "images": {
- "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "sourceProvenance": {
+ "description": "A permanent fixed identifier for source.\n@OutputOnly",
+ "$ref": "SourceProvenance"
}
- }
+ },
+ "id": "Build",
+ "description": "A build resource in the Container Builder API.\n\nAt a high level, a Build describes where to find source code, how to build\nit (for example, the builder image to run on the source), and what tag to\napply to the built image when it is pushed to Google Container Registry.\n\nFields can include the following variables which will be expanded when the\nbuild is created:\n\n- $PROJECT_ID: the project ID of the build.\n- $BUILD_ID: the autogenerated ID of the build.\n- $REPO_NAME: the source repository name specified by RepoSource.\n- $BRANCH_NAME: the branch name specified by RepoSource.\n- $TAG_NAME: the tag name specified by RepoSource.\n- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or\n resolved from the specified branch or tag.",
+ "type": "object"
},
"CancelBuildRequest": {
- "properties": {},
- "id": "CancelBuildRequest",
"description": "Request to cancel an ongoing build.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "CancelBuildRequest"
},
"ListBuildsResponse": {
"description": "Response including listed builds.",
@@ -209,17 +695,16 @@
"type": "string"
},
"builds": {
+ "description": "Builds will be sorted by create_time, descending.",
"type": "array",
"items": {
"$ref": "Build"
- },
- "description": "Builds will be sorted by create_time, descending."
+ }
}
},
"id": "ListBuildsResponse"
},
"ListOperationsResponse": {
- "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -234,27 +719,43 @@
}
},
"id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations."
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
},
"Source": {
- "id": "Source",
- "description": "Source describes the location of the source in a supported storage\nservice.",
- "type": "object",
"properties": {
+ "storageSource": {
+ "description": "If provided, get the source from this location in in Google Cloud\nStorage.",
+ "$ref": "StorageSource"
+ },
"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 in Google Cloud\nStorage."
}
- }
+ },
+ "id": "Source",
+ "description": "Source describes the location of the source in a supported storage\nservice.",
+ "type": "object"
},
"BuildOptions": {
"description": "Optional arguments to enable specific features of builds.",
"type": "object",
"properties": {
+ "sourceProvenanceHash": {
+ "description": "Requested hash for SourceProvenance.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ]
+ },
"requestedVerifyOption": {
"enum": [
"NOT_VERIFIED",
@@ -266,21 +767,6 @@
"Not a verifiable build. (default)",
"Verified build."
]
- },
- "sourceProvenanceHash": {
- "description": "Requested hash for SourceProvenance.",
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "NONE",
- "SHA256"
- ]
- },
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ]
}
},
"id": "BuildOptions"
@@ -289,10 +775,6 @@
"description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
"type": "object",
"properties": {
- "object": {
- "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
- "type": "string"
- },
"generation": {
"description": "Google Cloud Storage generation for the object. If the generation is\nomitted, the latest generation will be used.",
"format": "int64",
@@ -301,30 +783,34 @@
"bucket": {
"description": "Google Cloud Storage bucket containing source (see\n[Bucket Name\nRequirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
"type": "string"
+ },
+ "object": {
+ "description": "Google Cloud Storage object containing source.\n\nThis object must be a gzipped archive file (.tar.gz) containing source to\nbuild.",
+ "type": "string"
}
},
"id": "StorageSource"
},
"Results": {
- "description": "Results describes the artifacts created by the build pipeline.",
- "type": "object",
"properties": {
- "buildStepImages": {
- "description": "List of build step digests, in order corresponding to build step indices.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"images": {
"description": "Images that were built as a part of the build.",
"type": "array",
"items": {
"$ref": "BuiltImage"
}
+ },
+ "buildStepImages": {
+ "description": "List of build step digests, in order corresponding to build step indices.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
- "id": "Results"
+ "id": "Results",
+ "description": "Results describes the artifacts created by the build pipeline.",
+ "type": "object"
},
"BuildOperationMetadata": {
"description": "Metadata for build operations.",
@@ -338,26 +824,26 @@
"id": "BuildOperationMetadata"
},
"SourceProvenance": {
- "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
- "type": "object",
"properties": {
- "resolvedStorageSource": {
- "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
- "$ref": "StorageSource"
- },
"fileHashes": {
- "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",
"additionalProperties": {
"$ref": "FileHashes"
- }
+ },
+ "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly",
+ "type": "object"
},
"resolvedRepoSource": {
"description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved.",
"$ref": "RepoSource"
+ },
+ "resolvedStorageSource": {
+ "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.",
+ "$ref": "StorageSource"
}
},
- "id": "SourceProvenance"
+ "id": "SourceProvenance",
+ "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.",
+ "type": "object"
},
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
@@ -365,43 +851,27 @@
"properties": {},
"id": "CancelOperationRequest"
},
- "ListBuildTriggersResponse": {
- "description": "Response containing existing BuildTriggers.",
- "type": "object",
- "properties": {
- "triggers": {
- "description": "BuildTriggers for the project, sorted by create_time descending.",
- "type": "array",
- "items": {
- "$ref": "BuildTrigger"
- }
- }
- },
- "id": "ListBuildTriggersResponse"
- },
"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": {
@@ -412,9 +882,27 @@
"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"
+ },
+ "ListBuildTriggersResponse": {
+ "properties": {
+ "triggers": {
+ "description": "BuildTriggers for the project, sorted by create_time descending.",
+ "type": "array",
+ "items": {
+ "$ref": "BuildTrigger"
+ }
+ }
+ },
+ "id": "ListBuildTriggersResponse",
+ "description": "Response containing existing BuildTriggers.",
+ "type": "object"
},
"BuiltImage": {
+ "description": "BuiltImage describes an image built by the pipeline.",
+ "type": "object",
"properties": {
"name": {
"description": "Name used to push the container image to Google Container Registry, as\npresented to `docker push`.",
@@ -425,37 +913,9 @@
"type": "string"
}
},
- "id": "BuiltImage",
- "description": "BuiltImage describes an image built by the pipeline.",
- "type": "object"
- },
- "Hash": {
- "id": "Hash",
- "description": "Container message for hash values.",
- "type": "object",
- "properties": {
- "type": {
- "description": "The type of hash that was performed.",
- "type": "string",
- "enumDescriptions": [
- "No hash requested.",
- "Use a sha256 hash."
- ],
- "enum": [
- "NONE",
- "SHA256"
- ]
- },
- "value": {
- "description": "The hash value.",
- "format": "byte",
- "type": "string"
- }
- }
+ "id": "BuiltImage"
},
"RepoSource": {
- "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
- "type": "object",
"properties": {
"tagName": {
"description": "Name of the tag to build.",
@@ -478,37 +938,38 @@
"type": "string"
}
},
- "id": "RepoSource"
+ "id": "RepoSource",
+ "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
+ "type": "object"
+ },
+ "Hash": {
+ "description": "Container message for hash values.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The hash value.",
+ "format": "byte",
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "NONE",
+ "SHA256"
+ ],
+ "description": "The type of hash that was performed.",
+ "type": "string",
+ "enumDescriptions": [
+ "No hash requested.",
+ "Use a sha256 hash."
+ ]
+ }
+ },
+ "id": "Hash"
},
"BuildStep": {
"description": "BuildStep describes a step to perform in the build pipeline.",
"type": "object",
"properties": {
- "dir": {
- "description": "Working directory (relative to project source root) to use when running\nthis operation's container.",
- "type": "string"
- },
- "env": {
- "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "waitFor": {
- "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "args": {
- "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"name": {
"description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n(https://github.com/GoogleCloudPlatform/cloud-builders). The Docker daemon\nwill also have cached many of the layers for some popular images, like\n\"ubuntu\", \"debian\", but they will be refreshed at the time you attempt to\nuse 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"
@@ -520,23 +981,48 @@
"id": {
"description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.",
"type": "string"
+ },
+ "dir": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "env": {
+ "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "args": {
+ "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"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.",
- "type": "object",
"properties": {
"fileHash": {
+ "description": "Collection of file hashes.",
"type": "array",
"items": {
"$ref": "Hash"
- },
- "description": "Collection of file hashes."
+ }
}
},
- "id": "FileHashes"
+ "id": "FileHashes",
+ "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.",
+ "type": "object"
}
},
"protocol": "rest",
@@ -557,491 +1043,5 @@
"rootUrl": "https://cloudbuild.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudbuild",
- "batchPath": "batch",
- "title": "Google Cloud Container Builder API",
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "flatPath": "v1/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "cloudbuild.operations.cancel",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "list": {
- "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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path",
- "description": "The name of the operation collection."
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/operations"
- },
- "get": {
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "cloudbuild.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- }
- }
- }
- },
- "projects": {
- "resources": {
- "builds": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "required": true,
- "type": "string"
- },
- "id": {
- "description": "ID of the build.",
- "required": true,
- "type": "string",
- "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."
- },
- "list": {
- "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListBuildsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "description": "The raw filter text to constrain the results.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Token to provide to skip to a particular spot in the list.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of results to return in the list.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.list",
- "path": "v1/projects/{projectId}/builds"
- },
- "create": {
- "request": {
- "$ref": "Build"
- },
- "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).",
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "projectId": {
- "description": "ID of the project.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/builds",
- "id": "cloudbuild.projects.builds.create",
- "path": "v1/projects/{projectId}/builds"
- },
- "cancel": {
- "response": {
- "$ref": "Build"
- },
- "parameterOrder": [
- "projectId",
- "id"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project.",
- "required": true,
- "type": "string"
- },
- "id": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the build."
- }
- },
- "flatPath": "v1/projects/{projectId}/builds/{id}:cancel",
- "path": "v1/projects/{projectId}/builds/{id}:cancel",
- "id": "cloudbuild.projects.builds.cancel",
- "description": "Cancels a requested build in progress.",
- "request": {
- "$ref": "CancelBuildRequest"
- }
- }
- }
- },
- "triggers": {
- "methods": {
- "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.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to delete.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
- },
- "get": {
- "id": "cloudbuild.projects.triggers.get",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string"
- },
- "triggerId": {
- "location": "path",
- "description": "ID of the BuildTrigger to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}"
- },
- "list": {
- "description": "Lists existing BuildTrigger.\n\nThis API is experimental.",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListBuildTriggersResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "projectId": {
- "description": "ID of the project for which to list BuildTriggers.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "path": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.list"
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "triggerId"
- ],
- "response": {
- "$ref": "BuildTrigger"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "ID of the project that owns the trigger.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "triggerId": {
- "description": "ID of the BuildTrigger to update.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/triggers/{triggerId}",
- "id": "cloudbuild.projects.triggers.patch",
- "path": "v1/projects/{projectId}/triggers/{triggerId}",
- "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.",
- "request": {
- "$ref": "BuildTrigger"
- }
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "BuildTrigger"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the project for which to configure automatic builds.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/triggers",
- "id": "cloudbuild.projects.triggers.create",
- "path": "v1/projects/{projectId}/triggers",
- "request": {
- "$ref": "BuildTrigger"
- },
- "description": "Creates a new BuildTrigger.\n\nThis API is experimental."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "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": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://cloudbuild.googleapis.com/",
- "servicePath": "",
- "description": "Builds container images in the cloud.",
- "kind": "discovery#restDescription"
+ "batchPath": "batch"
}
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json
index af623b6..f0cf9a2 100644
--- a/clouddebugger/v2/clouddebugger-api.json
+++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,377 +1,34 @@
{
+ "revision": "20170214",
+ "documentationLink": "http://cloud.google.com/debugger",
+ "id": "clouddebugger:v2",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "SourceLocation": {
- "type": "object",
- "properties": {
- "line": {
- "type": "integer",
- "description": "Line inside the file. The first line in the file has the value `1`.",
- "format": "int32"
- },
- "path": {
- "description": "Path to the source file within the source context of the target binary.",
- "type": "string"
- }
- },
- "id": "SourceLocation",
- "description": "Represents a location in the source code."
- },
- "Debuggee": {
- "type": "object",
- "properties": {
- "uniquifier": {
- "description": "Debuggee uniquifier within the project.\nAny string that identifies the application within the project can be used.\nIncluding environment and version or build IDs is recommended.",
- "type": "string"
- },
- "description": {
- "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.",
- "type": "string"
- },
- "sourceContexts": {
- "type": "array",
- "items": {
- "$ref": "SourceContext"
- },
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: This field is deprecated. Consumers should use\n`ext_source_contexts` if it is not empty. Debug agents should populate\nboth this field and `ext_source_contexts`."
- },
- "extSourceContexts": {
- "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nContexts describing a remote repo related to the source code\nhave a `category` label of `remote_repo`. Source snapshot source\ncontexts have a `category` of `snapshot`.",
- "type": "array",
- "items": {
- "$ref": "ExtendedSourceContext"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
- },
- "isInactive": {
- "type": "boolean",
- "description": "If set to `true`, indicates that the debuggee is considered as inactive by\nthe Controller service."
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status."
- },
- "project": {
- "type": "string",
- "description": "Project the debuggee is associated with.\nUse the project number when registering a Google Cloud Platform project."
- },
- "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 release. The version ID is structured as\nfollowing: `domain/type/vmajor.minor` (for example\n`google.com/gcp-java/v1.1`).",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the debuggee generated by the controller service.",
- "type": "string"
- }
- },
- "id": "Debuggee",
- "description": "Represents the application to debug. 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.\nThe agents attached to the same debuggee are identified by using exactly the\nsame field values when registering."
- },
- "ListActiveBreakpointsResponse": {
- "type": "object",
- "properties": {
- "waitExpired": {
- "type": "boolean",
- "description": "The `wait_expired` field is set to true by the server when the\nrequest times out and the field `success_on_timeout` is set to true."
- },
- "nextWaitToken": {
- "description": "A wait token that can be used in the next method call to block until\nthe list of breakpoints changes.",
- "type": "string"
- },
- "breakpoints": {
- "type": "array",
- "items": {
- "$ref": "Breakpoint"
- },
- "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint."
- }
- },
- "id": "ListActiveBreakpointsResponse",
- "description": "Response for listing active breakpoints."
- },
- "ProjectRepoId": {
- "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The ID of the project.",
- "type": "string"
- },
- "repoName": {
- "description": "The name of the repo. Leave empty for the default repo.",
- "type": "string"
- }
- },
- "id": "ProjectRepoId"
- },
- "CloudWorkspaceSourceContext": {
- "type": "object",
- "properties": {
- "workspaceId": {
- "$ref": "CloudWorkspaceId",
- "description": "The ID of the workspace."
- },
- "snapshotId": {
- "type": "string",
- "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot."
- }
- },
- "id": "CloudWorkspaceSourceContext",
- "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot."
- },
- "GerritSourceContext": {
- "type": "object",
- "properties": {
- "gerritProject": {
- "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
- "type": "string"
- },
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
- },
- "hostUri": {
- "type": "string",
- "description": "The URI of a running Gerrit instance."
- },
- "revisionId": {
- "description": "A revision (commit) ID.",
- "type": "string"
- },
- "aliasName": {
- "description": "The name of an alias (branch, tag, etc.).",
- "type": "string"
- }
- },
- "id": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
- },
- "UpdateActiveBreakpointResponse": {
- "type": "object",
- "properties": {},
- "id": "UpdateActiveBreakpointResponse",
- "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions."
- },
- "CloudWorkspaceId": {
- "type": "object",
- "properties": {
- "repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo containing the workspace."
- },
- "name": {
- "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
- "type": "string"
- }
- },
- "id": "CloudWorkspaceId",
- "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."
- },
- "ListBreakpointsResponse": {
- "type": "object",
- "properties": {
- "breakpoints": {
- "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of it's status.",
- "type": "array",
- "items": {
- "$ref": "Breakpoint"
- }
- },
- "nextWaitToken": {
- "type": "string",
- "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes."
- }
- },
- "id": "ListBreakpointsResponse",
- "description": "Response for listing breakpoints."
- },
- "Breakpoint": {
- "description": "Represents the breakpoint specification, status and results.",
- "type": "object",
- "properties": {
- "expressions": {
- "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "evaluatedExpressions": {
- "type": "array",
- "items": {
- "$ref": "Variable"
- },
- "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text."
- },
- "isFinalState": {
- "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
- "type": "boolean"
- },
- "stackFrames": {
- "type": "array",
- "items": {
- "$ref": "StackFrame"
- },
- "description": "The stack at breakpoint time."
- },
- "condition": {
- "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.",
- "type": "string"
- },
- "status": {
- "$ref": "StatusMessage",
- "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition"
- },
- "userEmail": {
- "description": "E-mail address of the user that created this breakpoint",
- "type": "string"
- },
- "action": {
- "type": "string",
- "enumDescriptions": [
- "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
- "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
- ],
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit."
- },
- "logLevel": {
- "type": "string",
- "enumDescriptions": [
- "Information log message.",
- "Warning log message.",
- "Error log message."
- ],
- "enum": [
- "INFO",
- "WARNING",
- "ERROR"
- ],
- "description": "Indicates the severity of the log. Only relevant when action is `LOG`."
- },
- "id": {
- "description": "Breakpoint identifier, unique in the scope of the debuggee.",
- "type": "string"
- },
- "location": {
- "$ref": "SourceLocation",
- "description": "Breakpoint source location."
- },
- "finalTime": {
- "type": "string",
- "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
- "format": "google-datetime"
- },
- "variableTable": {
- "type": "array",
- "items": {
- "$ref": "Variable"
- },
- "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."
- },
- "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"
- },
- "createTime": {
- "description": "Time this breakpoint was created by the server in seconds resolution.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
- "type": "object"
- }
- },
- "id": "Breakpoint"
- },
- "UpdateActiveBreakpointRequest": {
- "type": "object",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Updated breakpoint information.\nThe field 'id' must be set."
- }
- },
- "id": "UpdateActiveBreakpointRequest",
- "description": "Request to update an active breakpoint."
- },
- "SetBreakpointResponse": {
- "type": "object",
- "properties": {
- "breakpoint": {
- "$ref": "Breakpoint",
- "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
- }
- },
- "id": "SetBreakpointResponse",
- "description": "Response for setting a breakpoint."
- },
- "SourceContext": {
- "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
- "type": "object",
- "properties": {
- "git": {
- "$ref": "GitSourceContext",
- "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)."
- },
- "gerrit": {
- "$ref": "GerritSourceContext",
- "description": "A SourceContext referring to a Gerrit project."
- },
- "cloudRepo": {
- "$ref": "CloudRepoSourceContext",
- "description": "A SourceContext referring to a revision in a cloud repo."
- },
- "cloudWorkspace": {
- "$ref": "CloudWorkspaceSourceContext",
- "description": "A SourceContext referring to a snapshot in a cloud workspace."
- }
- },
- "id": "SourceContext"
- },
"CloudRepoSourceContext": {
"description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).",
"type": "object",
"properties": {
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
+ },
"revisionId": {
- "type": "string",
- "description": "A revision ID."
+ "description": "A revision ID.",
+ "type": "string"
},
"aliasName": {
"description": "The name of an alias (branch, tag, etc.).",
"type": "string"
},
"repoId": {
- "$ref": "RepoId",
- "description": "The ID of the repo."
- },
- "aliasContext": {
- "$ref": "AliasContext",
- "description": "An alias, which may be a branch or tag."
+ "description": "The ID of the repo.",
+ "$ref": "RepoId"
}
},
"id": "CloudRepoSourceContext"
},
"RegisterDebuggeeResponse": {
- "type": "object",
"properties": {
"debuggee": {
"$ref": "Debuggee",
@@ -379,35 +36,42 @@
}
},
"id": "RegisterDebuggeeResponse",
- "description": "Response for registering a debuggee."
+ "description": "Response for registering a debuggee.",
+ "type": "object"
},
"RegisterDebuggeeRequest": {
"description": "Request to register a debuggee.",
"type": "object",
"properties": {
"debuggee": {
- "$ref": "Debuggee",
- "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set."
+ "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set.",
+ "$ref": "Debuggee"
}
},
"id": "RegisterDebuggeeRequest"
},
"GetBreakpointResponse": {
- "description": "Response for getting breakpoint information.",
- "type": "object",
"properties": {
"breakpoint": {
- "$ref": "Breakpoint",
- "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set."
+ "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.",
+ "$ref": "Breakpoint"
}
},
- "id": "GetBreakpointResponse"
+ "id": "GetBreakpointResponse",
+ "description": "Response for getting breakpoint information.",
+ "type": "object"
},
"StatusMessage": {
- "type": "object",
"properties": {
+ "isError": {
+ "description": "Distinguishes errors from informational messages.",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Status message text.",
+ "$ref": "FormatMessage"
+ },
"refersTo": {
- "type": "string",
"enumDescriptions": [
"Status doesn't refer to any particular input.",
"Status applies to the breakpoint and is related to its location.",
@@ -426,19 +90,13 @@
"VARIABLE_NAME",
"VARIABLE_VALUE"
],
- "description": "Reference to which the message applies."
- },
- "isError": {
- "description": "Distinguishes errors from informational messages.",
- "type": "boolean"
- },
- "description": {
- "$ref": "FormatMessage",
- "description": "Status message text."
+ "description": "Reference to which the message applies.",
+ "type": "string"
}
},
"id": "StatusMessage",
- "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`."
+ "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).",
@@ -478,28 +136,23 @@
"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": {
- "type": "string",
- "description": "Simple value of the variable."
- },
"varTableIndex": {
- "type": "integer",
"description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
+ },
+ "value": {
+ "description": "Simple value of the variable.",
+ "type": "string"
}
},
"id": "Variable"
},
"StackFrame": {
- "type": "object",
"properties": {
- "location": {
- "$ref": "SourceLocation",
- "description": "Source location of the call site."
- },
"function": {
- "type": "string",
- "description": "Demangled function name at the call site."
+ "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.",
@@ -514,25 +167,30 @@
"items": {
"$ref": "Variable"
}
+ },
+ "location": {
+ "description": "Source location of the call site.",
+ "$ref": "SourceLocation"
}
},
"id": "StackFrame",
- "description": "Represents a stack frame context."
+ "description": "Represents a stack frame context.",
+ "type": "object"
},
"RepoId": {
- "description": "A unique identifier for a cloud repo.",
- "type": "object",
"properties": {
"uid": {
- "type": "string",
- "description": "A server-assigned, globally unique identifier."
+ "description": "A server-assigned, globally unique identifier.",
+ "type": "string"
},
"projectRepoId": {
- "$ref": "ProjectRepoId",
- "description": "A combination of a project ID and a repo name."
+ "description": "A combination of a project ID and a repo name.",
+ "$ref": "ProjectRepoId"
}
},
- "id": "RepoId"
+ "id": "RepoId",
+ "description": "A unique identifier for a cloud repo.",
+ "type": "object"
},
"FormatMessage": {
"description": "Represents a message with parameters.",
@@ -553,8 +211,6 @@
"id": "FormatMessage"
},
"ExtendedSourceContext": {
- "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
- "type": "object",
"properties": {
"context": {
"$ref": "SourceContext",
@@ -568,7 +224,9 @@
"type": "object"
}
},
- "id": "ExtendedSourceContext"
+ "id": "ExtendedSourceContext",
+ "description": "An ExtendedSourceContext is a SourceContext combined with additional\ndetails describing the context.",
+ "type": "object"
},
"AliasContext": {
"description": "An alias to a repo revision.",
@@ -579,7 +237,6 @@
"type": "string"
},
"kind": {
- "type": "string",
"enumDescriptions": [
"Do not use.",
"Git tag",
@@ -592,46 +249,392 @@
"MOVABLE",
"OTHER"
],
- "description": "The alias kind."
+ "description": "The alias kind.",
+ "type": "string"
}
},
"id": "AliasContext"
},
"ListDebuggeesResponse": {
- "type": "object",
"properties": {
"debuggees": {
+ "description": "List of debuggees accessible to the calling user.\nNote that the `description` field is the only human readable field\nthat should be displayed to the user.\nThe fields `debuggee.id` and `description` fields are guaranteed to be\nset on each debuggee.",
"type": "array",
"items": {
"$ref": "Debuggee"
- },
- "description": "List of debuggees accessible to the calling user.\nNote that the `description` field is the only human readable field\nthat should be displayed to the user.\nThe fields `debuggee.id` and `description` fields are guaranteed to be\nset on each debuggee."
+ }
}
},
"id": "ListDebuggeesResponse",
- "description": "Response for listing debuggees."
+ "description": "Response for listing debuggees.",
+ "type": "object"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
"properties": {},
- "id": "Empty"
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "SourceLocation": {
+ "properties": {
+ "path": {
+ "description": "Path to the source file within the source context of the target binary.",
+ "type": "string"
+ },
+ "line": {
+ "description": "Line inside the file. The first line in the file has the value `1`.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SourceLocation",
+ "description": "Represents a location in the source code.",
+ "type": "object"
+ },
+ "Debuggee": {
+ "properties": {
+ "project": {
+ "description": "Project the debuggee is associated with.\nUse the project number 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 release. The version ID is structured as\nfollowing: `domain/type/vmajor.minor` (for example\n`google.com/gcp-java/v1.1`).",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.",
+ "type": "boolean"
+ },
+ "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": "Debuggee uniquifier within the project.\nAny string that identifies the application within the project can be used.\nIncluding environment and version or build IDs is recommended.",
+ "type": "string"
+ },
+ "sourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nNOTE: This field is deprecated. Consumers should use\n`ext_source_contexts` if it is not empty. Debug agents should populate\nboth this field and `ext_source_contexts`.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceContext"
+ }
+ },
+ "extSourceContexts": {
+ "description": "References to the locations and revisions of the source code used in the\ndeployed application.\n\nContexts describing a remote repo related to the source code\nhave a `category` label of `remote_repo`. Source snapshot source\ncontexts have a `category` of `snapshot`.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedSourceContext"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
+ },
+ "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 the debuggee is considered as inactive by\nthe Controller service.",
+ "type": "boolean"
+ }
+ },
+ "id": "Debuggee",
+ "description": "Represents the application to debug. 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.\nThe agents attached to the same debuggee are identified by using exactly the\nsame field values when registering.",
+ "type": "object"
+ },
+ "ProjectRepoId": {
+ "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.",
+ "type": "object",
+ "properties": {
+ "projectId": {
+ "description": "The ID of the project.",
+ "type": "string"
+ },
+ "repoName": {
+ "description": "The name of the repo. Leave empty for the default repo.",
+ "type": "string"
+ }
+ },
+ "id": "ProjectRepoId"
+ },
+ "ListActiveBreakpointsResponse": {
+ "description": "Response for listing active breakpoints.",
+ "type": "object",
+ "properties": {
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next method call to block until\nthe list of breakpoints changes.",
+ "type": "string"
+ },
+ "breakpoints": {
+ "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.",
+ "type": "array",
+ "items": {
+ "$ref": "Breakpoint"
+ }
+ },
+ "waitExpired": {
+ "description": "The `wait_expired` field is set to true by the server when the\nrequest times out and the field `success_on_timeout` is set to true.",
+ "type": "boolean"
+ }
+ },
+ "id": "ListActiveBreakpointsResponse"
+ },
+ "CloudWorkspaceSourceContext": {
+ "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.",
+ "type": "object",
+ "properties": {
+ "snapshotId": {
+ "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.",
+ "type": "string"
+ },
+ "workspaceId": {
+ "description": "The ID of the workspace.",
+ "$ref": "CloudWorkspaceId"
+ }
+ },
+ "id": "CloudWorkspaceSourceContext"
+ },
+ "GerritSourceContext": {
+ "properties": {
+ "hostUri": {
+ "description": "The URI of a running Gerrit instance.",
+ "type": "string"
+ },
+ "revisionId": {
+ "description": "A revision (commit) ID.",
+ "type": "string"
+ },
+ "aliasName": {
+ "description": "The name of an alias (branch, tag, etc.).",
+ "type": "string"
+ },
+ "gerritProject": {
+ "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.",
+ "type": "string"
+ },
+ "aliasContext": {
+ "description": "An alias, which may be a branch or tag.",
+ "$ref": "AliasContext"
+ }
+ },
+ "id": "GerritSourceContext",
+ "description": "A SourceContext referring to a Gerrit project.",
+ "type": "object"
+ },
+ "UpdateActiveBreakpointResponse": {
+ "properties": {},
+ "id": "UpdateActiveBreakpointResponse",
+ "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.",
+ "type": "object"
+ },
+ "CloudWorkspaceId": {
+ "properties": {
+ "repoId": {
+ "$ref": "RepoId",
+ "description": "The ID of the repo containing the workspace."
+ },
+ "name": {
+ "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.",
+ "type": "string"
+ }
+ },
+ "id": "CloudWorkspaceId",
+ "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"
+ },
+ "ListBreakpointsResponse": {
+ "properties": {
+ "breakpoints": {
+ "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of it's status.",
+ "type": "array",
+ "items": {
+ "$ref": "Breakpoint"
+ }
+ },
+ "nextWaitToken": {
+ "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.",
+ "type": "string"
+ }
+ },
+ "id": "ListBreakpointsResponse",
+ "description": "Response for listing breakpoints.",
+ "type": "object"
+ },
+ "Breakpoint": {
+ "properties": {
+ "finalTime": {
+ "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "variableTable": {
+ "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.",
+ "type": "object"
+ },
+ "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"
+ },
+ "createTime": {
+ "description": "Time this breakpoint was created by the server in seconds resolution.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "expressions": {
+ "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "evaluatedExpressions": {
+ "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "isFinalState": {
+ "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.",
+ "type": "boolean"
+ },
+ "stackFrames": {
+ "description": "The stack at breakpoint time.",
+ "type": "array",
+ "items": {
+ "$ref": "StackFrame"
+ }
+ },
+ "condition": {
+ "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "StatusMessage",
+ "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition"
+ },
+ "userEmail": {
+ "description": "E-mail address of the user that created this breakpoint",
+ "type": "string"
+ },
+ "action": {
+ "enumDescriptions": [
+ "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.",
+ "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired."
+ ],
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.",
+ "type": "string"
+ },
+ "logLevel": {
+ "enumDescriptions": [
+ "Information log message.",
+ "Warning log message.",
+ "Error log message."
+ ],
+ "enum": [
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "Indicates the severity of the log. Only relevant when action is `LOG`.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Breakpoint source location.",
+ "$ref": "SourceLocation"
+ }
+ },
+ "id": "Breakpoint",
+ "description": "Represents the breakpoint specification, status and results.",
+ "type": "object"
+ },
+ "UpdateActiveBreakpointRequest": {
+ "description": "Request to update an active breakpoint.",
+ "type": "object",
+ "properties": {
+ "breakpoint": {
+ "description": "Updated breakpoint information.\nThe field 'id' must be set.",
+ "$ref": "Breakpoint"
+ }
+ },
+ "id": "UpdateActiveBreakpointRequest"
+ },
+ "SetBreakpointResponse": {
+ "properties": {
+ "breakpoint": {
+ "$ref": "Breakpoint",
+ "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)."
+ }
+ },
+ "id": "SetBreakpointResponse",
+ "description": "Response for setting a breakpoint.",
+ "type": "object"
+ },
+ "SourceContext": {
+ "properties": {
+ "gerrit": {
+ "description": "A SourceContext referring to a Gerrit project.",
+ "$ref": "GerritSourceContext"
+ },
+ "cloudRepo": {
+ "description": "A SourceContext referring to a revision in a cloud repo.",
+ "$ref": "CloudRepoSourceContext"
+ },
+ "cloudWorkspace": {
+ "description": "A SourceContext referring to a snapshot in a cloud workspace.",
+ "$ref": "CloudWorkspaceSourceContext"
+ },
+ "git": {
+ "description": "A SourceContext referring to any third party Git repo (e.g. GitHub).",
+ "$ref": "GitSourceContext"
+ }
+ },
+ "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"
}
},
- "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 Debugger",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/cloud_debugger": {
- "description": "Manage cloud debugger"
- },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/cloud_debugger": {
+ "description": "Manage cloud debugger"
}
}
}
@@ -648,142 +651,46 @@
"debuggees": {
"methods": {
"list": {
- "httpMethod": "GET",
"parameterOrder": [],
+ "httpMethod": "GET",
"response": {
"$ref": "ListDebuggeesResponse"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"parameters": {
- "project": {
- "type": "string",
- "location": "query",
- "description": "Project number of a Google Cloud project whose debuggees to list."
- },
"clientVersion": {
"location": "query",
"description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
"type": "string"
},
"includeInactive": {
+ "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.",
"type": "boolean",
+ "location": "query"
+ },
+ "project": {
"location": "query",
- "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active."
+ "description": "Project number of a Google Cloud project whose debuggees to list.",
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"flatPath": "v2/debugger/debuggees",
- "id": "clouddebugger.debugger.debuggees.list",
"path": "v2/debugger/debuggees",
+ "id": "clouddebugger.debugger.debuggees.list",
"description": "Lists all the debuggees that the user can set breakpoints to."
}
},
"resources": {
"breakpoints": {
"methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId",
- "breakpointId"
- ],
- "response": {
- "$ref": "GetBreakpointResponse"
- },
- "parameters": {
- "clientVersion": {
- "type": "string",
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`)."
- },
- "breakpointId": {
- "location": "path",
- "description": "ID of the breakpoint to get.",
- "required": true,
- "type": "string"
- },
- "debuggeeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the debuggee whose breakpoint to get."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.get",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "description": "Gets breakpoint information."
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "debuggeeId"
- ],
- "response": {
- "$ref": "ListBreakpointsResponse"
- },
- "parameters": {
- "debuggeeId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the debuggee whose breakpoints to list."
- },
- "waitToken": {
- "type": "string",
- "location": "query",
- "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`."
- },
- "clientVersion": {
- "type": "string",
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`)."
- },
- "action.value": {
- "location": "query",
- "enum": [
- "CAPTURE",
- "LOG"
- ],
- "description": "Only breakpoints with the specified action will pass the filter.",
- "type": "string"
- },
- "includeAllUsers": {
- "type": "boolean",
- "location": "query",
- "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller."
- },
- "includeInactive": {
- "location": "query",
- "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
- "type": "boolean"
- },
- "stripResults": {
- "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`."
- }
- },
- "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."
- },
"set": {
+ "description": "Sets the breakpoint to the debuggee.",
"request": {
"$ref": "Breakpoint"
},
- "description": "Sets the breakpoint to the debuggee.",
"response": {
"$ref": "SetBreakpointResponse"
},
@@ -791,42 +698,44 @@
"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.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ },
"debuggeeId": {
"location": "path",
"description": "ID of the debuggee where the breakpoint is to be set.",
"required": true,
"type": "string"
- },
- "clientVersion": {
- "type": "string",
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`)."
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud_debugger"
- ],
"flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
"path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set",
"id": "clouddebugger.debugger.debuggees.breakpoints.set"
},
"delete": {
- "httpMethod": "DELETE",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
+ "description": "Deletes the breakpoint from the debuggee.",
+ "response": {
+ "$ref": "Empty"
+ },
"parameterOrder": [
"debuggeeId",
"breakpointId"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
"parameters": {
- "clientVersion": {
- "type": "string",
- "location": "query",
- "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`)."
- },
"breakpointId": {
"location": "path",
"description": "ID of the breakpoint to delete.",
@@ -838,16 +747,110 @@
"description": "ID of the debuggee whose breakpoint to delete.",
"required": true,
"type": "string"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
+ },
+ "get": {
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.get",
+ "description": "Gets breakpoint information.",
+ "parameterOrder": [
+ "debuggeeId",
+ "breakpointId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GetBreakpointResponse"
+ },
+ "parameters": {
+ "breakpointId": {
+ "description": "ID of the breakpoint to get.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "debuggeeId": {
+ "description": "ID of the debuggee whose breakpoint to get.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clientVersion": {
+ "location": "query",
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
- "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "id": "clouddebugger.debugger.debuggees.breakpoints.delete",
- "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}",
- "description": "Deletes the breakpoint from the debuggee."
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "parameters": {
+ "includeAllUsers": {
+ "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "includeInactive": {
+ "location": "query",
+ "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.",
+ "type": "boolean"
+ },
+ "stripResults": {
+ "location": "query",
+ "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.",
+ "type": "boolean"
+ },
+ "debuggeeId": {
+ "location": "path",
+ "description": "ID of the debuggee whose breakpoints to list.",
+ "required": true,
+ "type": "string"
+ },
+ "waitToken": {
+ "location": "query",
+ "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The client version making the call.\nFollowing: `domain/type/version` (e.g., `google.com/intellij/v1`).",
+ "type": "string",
+ "location": "query"
+ },
+ "action.value": {
+ "location": "query",
+ "enum": [
+ "CAPTURE",
+ "LOG"
+ ],
+ "description": "Only breakpoints with the specified action will pass the filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.debugger.debuggees.breakpoints.list",
+ "description": "Lists all breakpoints for the debuggee."
}
}
}
@@ -860,13 +863,6 @@
"debuggees": {
"methods": {
"register": {
- "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 should call this method with\nthe same request content to get back the same stable `debuggee_id`. Agents\nshould call this method again whenever `google.rpc.Code.NOT_FOUND` is\nreturned from any controller method.\n\nThis allows the controller service to disable the agent or recover from any\ndata loss. If the debuggee is disabled by the server, the response will\nhave `is_disabled` set to `true`.",
- "request": {
- "$ref": "RegisterDebuggeeRequest"
- },
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -876,55 +872,24 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
- "parameters": {}
+ "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 should call this method with\nthe same request content to get back the same stable `debuggee_id`. Agents\nshould call this method again whenever `google.rpc.Code.NOT_FOUND` is\nreturned from any controller method.\n\nThis allows the controller service to disable the agent or recover from any\ndata loss. If the debuggee is disabled by the server, the response will\nhave `is_disabled` set to `true`.",
+ "request": {
+ "$ref": "RegisterDebuggeeRequest"
+ }
}
},
"resources": {
"breakpoints": {
"methods": {
- "list": {
- "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (location, condition, and expression\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"
- ],
- "response": {
- "$ref": "ListActiveBreakpointsResponse"
- },
- "parameters": {
- "debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee.",
- "required": true,
- "type": "string"
- },
- "successOnTimeout": {
- "location": "query",
- "description": "If set to `true`, returns `google.rpc.Code.OK` status and sets the\n`wait_expired` response field to `true` when the server-selected timeout\nhas expired (recommended).\n\nIf set to `false`, returns `google.rpc.Code.ABORTED` status when the\nserver-selected timeout has expired (deprecated).",
- "type": "boolean"
- },
- "waitToken": {
- "location": "query",
- "description": "A wait token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server selected timeout has\nexpired. The value should be set from the last returned response.",
- "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"
- },
"update": {
- "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
- "id": "clouddebugger.controller.debuggees.breakpoints.update",
- "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller\nservice.\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 `expression` 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"
},
+ "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller\nservice.\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 `expression` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.",
"response": {
"$ref": "UpdateActiveBreakpointResponse"
},
@@ -933,24 +898,62 @@
"id"
],
"httpMethod": "PUT",
+ "parameters": {
+ "debuggeeId": {
+ "description": "Identifies the debuggee being debugged.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "id": {
+ "description": "Breakpoint identifier, unique in the scope of the debuggee.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud_debugger"
],
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}",
+ "id": "clouddebugger.controller.debuggees.breakpoints.update"
+ },
+ "list": {
+ "path": "v2/controller/debuggees/{debuggeeId}/breakpoints",
+ "id": "clouddebugger.controller.debuggees.breakpoints.list",
+ "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (location, condition, and expression\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.",
+ "response": {
+ "$ref": "ListActiveBreakpointsResponse"
+ },
+ "parameterOrder": [
+ "debuggeeId"
+ ],
+ "httpMethod": "GET",
"parameters": {
"debuggeeId": {
- "location": "path",
- "description": "Identifies the debuggee being debugged.",
- "required": true,
- "type": "string"
- },
- "id": {
+ "description": "Identifies the debuggee.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Breakpoint identifier, unique in the scope of the debuggee."
+ "location": "path"
+ },
+ "successOnTimeout": {
+ "location": "query",
+ "description": "If set to `true`, returns `google.rpc.Code.OK` status and sets the\n`wait_expired` response field to `true` when the server-selected timeout\nhas expired (recommended).\n\nIf set to `false`, returns `google.rpc.Code.ABORTED` status when the\nserver-selected timeout has expired (deprecated).",
+ "type": "boolean"
+ },
+ "waitToken": {
+ "description": "A wait token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server selected timeout has\nexpired. The value should be set from the last returned response.",
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud_debugger"
+ ],
+ "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints"
}
}
}
@@ -960,41 +963,10 @@
}
},
"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": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
"upload_protocol": {
- "type": "string",
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
"prettyPrint": {
"location": "query",
@@ -1002,28 +974,28 @@
"type": "boolean",
"default": "true"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "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",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format."
+ "location": "query"
},
"callback": {
"location": "query",
@@ -1031,6 +1003,11 @@
"type": "string"
},
"alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1039,21 +1016,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": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
}
},
"version": "v2",
"baseUrl": "https://clouddebugger.googleapis.com/",
- "servicePath": "",
- "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
"kind": "discovery#restDescription",
- "basePath": "",
- "id": "clouddebugger:v2",
- "documentationLink": "http://cloud.google.com/debugger",
- "revision": "20170214"
+ "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
index 3792551..1777b53 100644
--- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json
+++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,8 +1,18 @@
{
+ "baseUrl": "https://clouderrorreporting.googleapis.com/",
+ "servicePath": "",
+ "description": "Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors.\n",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "clouderrorreporting:v1beta1",
+ "documentationLink": "https://cloud.google.com/error-reporting/",
+ "revision": "20170220",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
"ReportedErrorEvent": {
+ "description": "An error event which is reported to the Error Reporting system.",
+ "type": "object",
"properties": {
"serviceContext": {
"$ref": "ServiceContext",
@@ -22,9 +32,7 @@
"type": "string"
}
},
- "id": "ReportedErrorEvent",
- "description": "An error event which is reported to the Error Reporting system.",
- "type": "object"
+ "id": "ReportedErrorEvent"
},
"ErrorContext": {
"description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
@@ -60,6 +68,26 @@
"description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.",
"type": "object",
"properties": {
+ "firstSeenTime": {
+ "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "count": {
+ "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
+ "format": "int64",
+ "type": "string"
+ },
+ "lastSeenTime": {
+ "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "affectedUsersCount": {
+ "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
+ "format": "int64",
+ "type": "string"
+ },
"numAffectedServices": {
"description": "The total number of services with a non-zero error count for the given\nfilter criteria.",
"format": "int32",
@@ -84,33 +112,15 @@
}
},
"group": {
- "$ref": "ErrorGroup",
- "description": "Group data that is independent of the filter criteria."
- },
- "firstSeenTime": {
- "description": "Approximate first occurrence that was ever seen for this group\nand which matches the given filter criteria, ignoring the\ntime_range that was specified in the request.",
- "format": "google-datetime",
- "type": "string"
- },
- "count": {
- "description": "Approximate total number of events in the given group that match\nthe filter criteria.",
- "format": "int64",
- "type": "string"
- },
- "affectedUsersCount": {
- "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.",
- "format": "int64",
- "type": "string"
- },
- "lastSeenTime": {
- "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.",
- "format": "google-datetime",
- "type": "string"
+ "description": "Group data that is independent of the filter criteria.",
+ "$ref": "ErrorGroup"
}
},
"id": "ErrorGroupStats"
},
"ListEventsResponse": {
+ "description": "Contains a set of requested error events.",
+ "type": "object",
"properties": {
"timeRangeBegin": {
"description": "The timestamp specifies the start time to which the request was restricted.",
@@ -129,11 +139,11 @@
"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": {
"description": "End of the time period to which `count` refers (excluded).",
@@ -151,11 +161,11 @@
"type": "string"
}
},
- "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"
+ "id": "TimedCount"
},
"ErrorGroup": {
+ "description": "Description of a group of similar error events.",
+ "type": "object",
"properties": {
"groupId": {
"description": "Group IDs are unique for a given project. If the same kind of error\noccurs in different service contexts, it will receive the same group ID.",
@@ -173,14 +183,17 @@
"type": "string"
}
},
- "id": "ErrorGroup",
- "description": "Description of a group of similar error events.",
- "type": "object"
+ "id": "ErrorGroup"
},
"SourceLocation": {
"description": "Indicates a location in the source code of the service for which\nerrors are reported.\nThis data should be provided by the application when reporting an error,\nunless the error report has been generated automatically from Google App\nEngine logs. All fields are optional.",
"type": "object",
"properties": {
+ "lineNumber": {
+ "description": "1-based. 0 indicates that the line number is unknown.",
+ "format": "int32",
+ "type": "integer"
+ },
"functionName": {
"description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.",
"type": "string"
@@ -188,17 +201,18 @@
"filePath": {
"description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.",
"type": "string"
- },
- "lineNumber": {
- "description": "1-based. 0 indicates that the line number is unknown.",
- "format": "int32",
- "type": "integer"
}
},
"id": "SourceLocation"
},
"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.",
"type": "string"
@@ -206,34 +220,20 @@
"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"
+ "id": "ServiceContext"
},
"ReportErrorEventResponse": {
- "properties": {},
- "id": "ReportErrorEventResponse",
"description": "Response for reporting an individual error event.\nData may be added to this message in the future.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "ReportErrorEventResponse"
},
"HttpRequestContext": {
"description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.",
"type": "object",
"properties": {
- "method": {
- "description": "The type of HTTP request, such as `GET`, `POST`, etc.",
- "type": "string"
- },
- "remoteIp": {
- "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
- "type": "string"
- },
"referrer": {
"description": "The referrer information that is provided with the request.",
"type": "string"
@@ -250,6 +250,14 @@
"description": "The HTTP response status code for the request.",
"format": "int32",
"type": "integer"
+ },
+ "method": {
+ "description": "The type of HTTP request, such as `GET`, `POST`, etc.",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.",
+ "type": "string"
}
},
"id": "HttpRequestContext"
@@ -258,6 +266,10 @@
"description": "Contains a set of requested error group stats.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.",
+ "type": "string"
+ },
"timeRangeBegin": {
"description": "The timestamp specifies the start time to which the request was restricted.\nThe start time is set based on the requested time range. It may be adjusted\nto a later time if a project has exceeded the storage quota and older data\nhas been deleted.",
"format": "google-datetime",
@@ -269,10 +281,6 @@
"items": {
"$ref": "ErrorGroupStats"
}
- },
- "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": "ListGroupStatsResponse"
@@ -287,6 +295,11 @@
"description": "An error event which is returned by the Error Reporting system.",
"type": "object",
"properties": {
+ "eventTime": {
+ "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"context": {
"$ref": "ErrorContext",
"description": "Data about the context in which the error occurred."
@@ -296,13 +309,8 @@
"type": "string"
},
"serviceContext": {
- "description": "The `ServiceContext` for which this error was reported.",
- "$ref": "ServiceContext"
- },
- "eventTime": {
- "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.",
- "format": "google-datetime",
- "type": "string"
+ "$ref": "ServiceContext",
+ "description": "The `ServiceContext` for which this error was reported."
}
},
"id": "ErrorEvent"
@@ -310,8 +318,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"
+ "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": {
@@ -333,16 +341,14 @@
"projects": {
"methods": {
"deleteEvents": {
- "path": "v1beta1/{+projectName}/events",
- "id": "clouderrorreporting.projects.deleteEvents",
"description": "Deletes all error events of a given project.",
- "response": {
- "$ref": "DeleteEventsResponse"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"projectName"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "DeleteEventsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
@@ -355,82 +361,18 @@
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/events"
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "id": "clouderrorreporting.projects.deleteEvents",
+ "path": "v1beta1/{+projectName}/events"
}
},
"resources": {
"events": {
"methods": {
- "list": {
- "id": "clouderrorreporting.projects.events.list",
- "path": "v1beta1/{+projectName}/events",
- "description": "Lists the specified events.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListEventsResponse"
- },
- "parameterOrder": [
- "projectName"
- ],
- "parameters": {
- "groupId": {
- "description": "[Required] The group for which events shall be returned.",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "location": "query",
- "description": "[Optional] A `next_page_token` provided by a previous response.",
- "type": "string"
- },
- "serviceFilter.service": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "[Optional] The maximum number of results to return per response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "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": {
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
- "type": "string",
- "location": "query"
- },
- "timeRange.period": {
- "location": "query",
- "enum": [
- "PERIOD_UNSPECIFIED",
- "PERIOD_1_HOUR",
- "PERIOD_6_HOURS",
- "PERIOD_1_DAY",
- "PERIOD_1_WEEK",
- "PERIOD_30_DAYS"
- ],
- "description": "Restricts the query to the specified time range.",
- "type": "string"
- },
- "projectName": {
- "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/events"
- },
"report": {
+ "flatPath": "v1beta1/projects/{projectsId}/events:report",
+ "path": "v1beta1/{+projectName}/events:report",
+ "id": "clouderrorreporting.projects.events.report",
"request": {
"$ref": "ReportedErrorEvent"
},
@@ -444,24 +386,115 @@
"httpMethod": "POST",
"parameters": {
"projectName": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
"required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "description": "Lists the specified events.",
+ "response": {
+ "$ref": "ListEventsResponse"
+ },
+ "parameterOrder": [
+ "projectName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceFilter.resourceType": {
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "type": "string",
+ "location": "query"
+ },
+ "timeRange.period": {
+ "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"
+ ]
+ },
+ "projectName": {
+ "location": "path",
+ "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "groupId": {
+ "location": "query",
+ "description": "[Required] The group for which events shall be returned.",
+ "type": "string"
+ },
+ "serviceFilter.service": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "[Optional] The maximum number of results to return per response.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectsId}/events:report",
- "path": "v1beta1/{+projectName}/events:report",
- "id": "clouderrorreporting.projects.events.report"
+ "flatPath": "v1beta1/projects/{projectsId}/events",
+ "path": "v1beta1/{+projectName}/events",
+ "id": "clouderrorreporting.projects.events.list"
}
}
},
"groups": {
"methods": {
+ "get": {
+ "description": "Get the specified group.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "groupName"
+ ],
+ "response": {
+ "$ref": "ErrorGroup"
+ },
+ "parameters": {
+ "groupName": {
+ "location": "path",
+ "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
+ "id": "clouderrorreporting.projects.groups.get",
+ "path": "v1beta1/{+groupName}"
+ },
"update": {
"description": "Replace the data for the specified group.\nFails if the group does not exist.",
"request": {
@@ -479,47 +512,23 @@
],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path",
"description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e",
"required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "id": "clouderrorreporting.projects.groups.update",
- "path": "v1beta1/{+name}"
- },
- "get": {
- "description": "Get the specified group.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ErrorGroup"
- },
- "parameterOrder": [
- "groupName"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "groupName": {
- "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e",
- "required": true,
"type": "string",
"pattern": "^projects/[^/]+/groups/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}",
- "id": "clouderrorreporting.projects.groups.get",
- "path": "v1beta1/{+groupName}"
+ "id": "clouderrorreporting.projects.groups.update",
+ "path": "v1beta1/{+name}"
}
}
},
"groupStats": {
"methods": {
"list": {
+ "description": "Lists the specified groups.",
"response": {
"$ref": "ListGroupStatsResponse"
},
@@ -531,62 +540,12 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
- "timedCountDuration": {
- "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
- "format": "google-duration",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "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": {
- "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": {
- "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "serviceFilter.service": {
- "location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).",
- "type": "string"
- },
"pageSize": {
"description": "[Optional] The maximum number of results to return per response.\nDefault is 20.",
"format": "int32",
"type": "integer",
"location": "query"
},
- "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"
- },
"order": {
"location": "query",
"enum": [
@@ -599,9 +558,9 @@
"description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.",
"type": "string"
},
- "serviceFilter.resourceType": {
+ "serviceFilter.version": {
"location": "query",
- "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).",
"type": "string"
},
"alignmentTime": {
@@ -610,18 +569,67 @@
"format": "google-datetime",
"type": "string"
},
+ "serviceFilter.resourceType": {
+ "location": "query",
+ "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).",
+ "type": "string"
+ },
"projectName": {
"description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
"location": "path"
+ },
+ "timedCountDuration": {
+ "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.",
+ "format": "google-duration",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.",
+ "type": "string",
+ "location": "query"
+ },
+ "timeRange.period": {
+ "location": "query",
+ "enum": [
+ "PERIOD_UNSPECIFIED",
+ "PERIOD_1_HOUR",
+ "PERIOD_6_HOURS",
+ "PERIOD_1_DAY",
+ "PERIOD_1_WEEK",
+ "PERIOD_30_DAYS"
+ ],
+ "description": "Restricts the query to the specified time range.",
+ "type": "string"
+ },
+ "alignment": {
+ "location": "query",
+ "enum": [
+ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED",
+ "ALIGNMENT_EQUAL_ROUNDED",
+ "ALIGNMENT_EQUAL_AT_END"
+ ],
+ "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.",
+ "type": "string"
+ },
+ "groupId": {
+ "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"
}
},
"flatPath": "v1beta1/projects/{projectsId}/groupStats",
"path": "v1beta1/{+projectName}/groupStats",
- "id": "clouderrorreporting.projects.groupStats.list",
- "description": "Lists the specified groups."
+ "id": "clouderrorreporting.projects.groupStats.list"
}
}
}
@@ -629,21 +637,11 @@
}
},
"parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "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": {
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
@@ -679,12 +677,6 @@
"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": [
@@ -692,11 +684,12 @@
"media",
"proto"
],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
"type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query"
},
"key": {
@@ -704,25 +697,32 @@
"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.",
+ "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"
}
},
- "version": "v1beta1",
- "baseUrl": "https://clouderrorreporting.googleapis.com/",
- "description": "Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors.\n",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "basePath": "",
- "documentationLink": "https://cloud.google.com/error-reporting/",
- "revision": "20170220",
- "id": "clouderrorreporting:v1beta1"
+ "version": "v1beta1"
}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json
new file mode 100644
index 0000000..3087d1e
--- /dev/null
+++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -0,0 +1,757 @@
+{
+ "rootUrl": "https://cloudfunctions.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudfunctions",
+ "batchPath": "batch",
+ "title": "Google Cloud Functions API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ },
+ "name": {
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations",
+ "id": "cloudfunctions.projects.locations.list",
+ "path": "v1beta2/{+name}/locations",
+ "description": "Lists information about the supported locations for this service."
+ }
+ },
+ "resources": {
+ "functions": {
+ "methods": {
+ "get": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "id": "cloudfunctions.projects.locations.functions.get",
+ "path": "v1beta2/{+name}",
+ "description": "Returns a function with the given name from the requested project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CloudFunction"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function which details should be obtained.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "update": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.update",
+ "description": "Updates existing function.",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the function to be updated.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "delete": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "cloudfunctions.projects.locations.functions.delete",
+ "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the function which should be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListFunctionsResponse"
+ },
+ "parameterOrder": [
+ "location"
+ ],
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$"
+ },
+ "pageToken": {
+ "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Maximum number of functions to return per call.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "id": "cloudfunctions.projects.locations.functions.list",
+ "path": "v1beta2/{+location}/functions",
+ "description": "Returns a list of functions that belong to the requested project."
+ },
+ "create": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ "id": "cloudfunctions.projects.locations.functions.create",
+ "path": "v1beta2/{+location}/functions",
+ "request": {
+ "$ref": "CloudFunction"
+ },
+ "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "location"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "location": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "call": {
+ "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ "id": "cloudfunctions.projects.locations.functions.call",
+ "path": "v1beta2/{+name}:call",
+ "request": {
+ "$ref": "CallFunctionRequest"
+ },
+ "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CallFunctionResponse"
+ },
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the function to be called.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "path": "v1beta2/operations",
+ "id": "cloudfunctions.operations.list",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "type": "string",
+ "location": "query",
+ "description": "The name of the operation collection."
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta2/operations/{operationsId}",
+ "id": "cloudfunctions.operations.get",
+ "path": "v1beta2/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "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": "20170309",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "OperationMetadataV1Beta2": {
+ "type": "object",
+ "properties": {
+ "target": {
+ "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1",
+ "type": "string"
+ },
+ "request": {
+ "description": "The original request that started the operation.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "type": {
+ "enum": [
+ "OPERATION_UNSPECIFIED",
+ "CREATE_FUNCTION",
+ "UPDATE_FUNCTION",
+ "DELETE_FUNCTION"
+ ],
+ "description": "Type of operation.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown operation type.",
+ "Triggered by CreateFunction call",
+ "Triggered by UpdateFunction call",
+ "Triggered by DeleteFunction call."
+ ]
+ }
+ },
+ "id": "OperationMetadataV1Beta2",
+ "description": "Metadata describing an Operation"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "CallFunctionRequest": {
+ "description": "Request for the `CallFunction` method.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "Input to be passed to the function.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionRequest"
+ },
+ "SourceRepository": {
+ "properties": {
+ "revision": {
+ "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
+ "repositoryUrl": {
+ "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.",
+ "type": "string"
+ },
+ "branch": {
+ "description": "The name of the branch from which the function should be fetched.",
+ "type": "string"
+ },
+ "deployedRevision": {
+ "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
+ "type": "string"
+ },
+ "sourcePath": {
+ "description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
+ "type": "string"
+ }
+ },
+ "id": "SourceRepository",
+ "description": "Describes the location of the function source in a remote repository.",
+ "type": "object"
+ },
+ "CloudFunction": {
+ "type": "object",
+ "properties": {
+ "updateTime": {
+ "description": "Output only. The last update timestamp of a Cloud Function.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "latestOperation": {
+ "description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
+ "type": "string"
+ },
+ "httpsTrigger": {
+ "description": "An HTTPS endpoint type of source that can be triggered via URL.",
+ "$ref": "HTTPSTrigger"
+ },
+ "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": {
+ "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "availableMemoryMb": {
+ "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string",
+ "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`"
+ },
+ "serviceAccount": {
+ "description": "Output only. The service account of the function.",
+ "type": "string"
+ },
+ "sourceArchiveUrl": {
+ "type": "string",
+ "description": "The URL, starting with gs://, pointing to the zip archive which contains\nthe function."
+ },
+ "sourceRepository": {
+ "$ref": "SourceRepository",
+ "description": "The hosted repository where the function is defined."
+ },
+ "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"
+ }
+ },
+ "id": "CloudFunction",
+ "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations."
+ },
+ "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": {
+ "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"
+ }
+ }
+ },
+ "id": "Location"
+ },
+ "ListOperationsResponse": {
+ "properties": {
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "ListFunctionsResponse": {
+ "id": "ListFunctionsResponse",
+ "description": "Response for the `ListFunctions` method.",
+ "type": "object",
+ "properties": {
+ "functions": {
+ "description": "The functions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "CloudFunction"
+ }
+ },
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.",
+ "type": "string"
+ }
+ }
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "CallFunctionResponse": {
+ "properties": {
+ "executionId": {
+ "description": "Execution id of function invocation.",
+ "type": "string"
+ },
+ "result": {
+ "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
+ "type": "string"
+ },
+ "error": {
+ "description": "Either system or user-function generated error. Set if execution\nwas not successful.",
+ "type": "string"
+ }
+ },
+ "id": "CallFunctionResponse",
+ "description": "Response of `CallFunction` method.",
+ "type": "object"
+ },
+ "EventTrigger": {
+ "properties": {
+ "resource": {
+ "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
+ "type": "string"
+ },
+ "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/firebase.database/eventTypes/data.write`",
+ "type": "string"
+ }
+ },
+ "id": "EventTrigger",
+ "description": "Describes EventTrigger, used to request events be sent from another\nservice.",
+ "type": "object"
+ },
+ "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"
+ }
+ }
+ },
+ "Operation": {
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ }
+ },
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "Cloud Functions",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ }
+}
diff --git a/cloudfunctions/v1beta2/cloudfunctions-gen.go b/cloudfunctions/v1beta2/cloudfunctions-gen.go
new file mode 100644
index 0000000..32b3fe5
--- /dev/null
+++ b/cloudfunctions/v1beta2/cloudfunctions-gen.go
@@ -0,0 +1,2268 @@
+// Package cloudfunctions provides access to the Google Cloud Functions API.
+//
+// See https://cloud.google.com/functions
+//
+// Usage example:
+//
+// import "google.golang.org/api/cloudfunctions/v1beta2"
+// ...
+// cloudfunctionsService, err := cloudfunctions.New(oauthHttpClient)
+package cloudfunctions // import "google.golang.org/api/cloudfunctions/v1beta2"
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ context "golang.org/x/net/context"
+ ctxhttp "golang.org/x/net/context/ctxhttp"
+ gensupport "google.golang.org/api/gensupport"
+ googleapi "google.golang.org/api/googleapi"
+ "io"
+ "net/http"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+// Always reference these packages, just in case the auto-generated code
+// below doesn't.
+var _ = bytes.NewBuffer
+var _ = strconv.Itoa
+var _ = fmt.Sprintf
+var _ = json.NewDecoder
+var _ = io.Copy
+var _ = url.Parse
+var _ = gensupport.MarshalJSON
+var _ = googleapi.Version
+var _ = errors.New
+var _ = strings.Replace
+var _ = context.Canceled
+var _ = ctxhttp.Do
+
+const apiId = "cloudfunctions:v1beta2"
+const apiName = "cloudfunctions"
+const apiVersion = "v1beta2"
+const basePath = "https://cloudfunctions.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // View and manage your data across Google Cloud Platform services
+ CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+)
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Operations = NewOperationsService(s)
+ s.Projects = NewProjectsService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+ GoogleClientHeaderElement string // client header fragment, for Google use only
+
+ Operations *OperationsService
+
+ Projects *ProjectsService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func (s *Service) clientHeader() string {
+ return gensupport.GoogleClientHeader("20170210", s.GoogleClientHeaderElement)
+}
+
+func NewOperationsService(s *Service) *OperationsService {
+ rs := &OperationsService{s: s}
+ return rs
+}
+
+type OperationsService struct {
+ s *Service
+}
+
+func NewProjectsService(s *Service) *ProjectsService {
+ rs := &ProjectsService{s: s}
+ rs.Locations = NewProjectsLocationsService(s)
+ return rs
+}
+
+type ProjectsService struct {
+ s *Service
+
+ Locations *ProjectsLocationsService
+}
+
+func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
+ rs := &ProjectsLocationsService{s: s}
+ rs.Functions = NewProjectsLocationsFunctionsService(s)
+ return rs
+}
+
+type ProjectsLocationsService struct {
+ s *Service
+
+ Functions *ProjectsLocationsFunctionsService
+}
+
+func NewProjectsLocationsFunctionsService(s *Service) *ProjectsLocationsFunctionsService {
+ rs := &ProjectsLocationsFunctionsService{s: s}
+ return rs
+}
+
+type ProjectsLocationsFunctionsService struct {
+ s *Service
+}
+
+// CallFunctionRequest: Request for the `CallFunction` method.
+type CallFunctionRequest struct {
+ // Data: Input to be passed to the function.
+ Data string `json:"data,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Data") 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. "Data") 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 *CallFunctionRequest) MarshalJSON() ([]byte, error) {
+ type noMethod CallFunctionRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CallFunctionResponse: Response of `CallFunction` method.
+type CallFunctionResponse struct {
+ // Error: Either system or user-function generated error. Set if
+ // execution
+ // was not successful.
+ Error string `json:"error,omitempty"`
+
+ // ExecutionId: Execution id of function invocation.
+ ExecutionId string `json:"executionId,omitempty"`
+
+ // Result: Result populated for successful execution of synchronous
+ // function. Will
+ // not be populated if function does not return a result through
+ // context.
+ Result string `json:"result,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Error") 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. "Error") 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 *CallFunctionResponse) MarshalJSON() ([]byte, error) {
+ type noMethod CallFunctionResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CloudFunction: Describes a Cloud Function that contains user
+// computation executed in
+// response to an event. It encapsulate function and triggers
+// configurations.
+type CloudFunction struct {
+ // AvailableMemoryMb: The amount of memory in MB available for a
+ // function.
+ // Defaults to 256MB.
+ AvailableMemoryMb int64 `json:"availableMemoryMb,omitempty"`
+
+ // EntryPoint: The name of the function (as defined in source code) that
+ // will be
+ // executed. Defaults to the resource name suffix, if not specified.
+ // For
+ // backward compatibility, if function with given name is not found,
+ // then the
+ // system will try to use function named "function".
+ // For Node.js this is name of a function exported by the module
+ // specified
+ // in `source_location`.
+ EntryPoint string `json:"entryPoint,omitempty"`
+
+ // EventTrigger: A source that fires events in response to a condition
+ // in another service.
+ EventTrigger *EventTrigger `json:"eventTrigger,omitempty"`
+
+ // HttpsTrigger: An HTTPS endpoint type of source that can be triggered
+ // via URL.
+ HttpsTrigger *HTTPSTrigger `json:"httpsTrigger,omitempty"`
+
+ // LatestOperation: Output only. Name of the most recent operation
+ // modifying the function. If
+ // the function status is `DEPLOYING` or `DELETING`, then it points to
+ // the
+ // active operation.
+ LatestOperation string `json:"latestOperation,omitempty"`
+
+ // Name: A user-defined name of the function. Function names must be
+ // unique
+ // globally and match pattern `projects/*/locations/*/functions/*`
+ Name string `json:"name,omitempty"`
+
+ // ServiceAccount: Output only. The service account of the function.
+ ServiceAccount string `json:"serviceAccount,omitempty"`
+
+ // SourceArchiveUrl: The URL, starting with gs://, pointing to the zip
+ // archive which contains
+ // the function.
+ SourceArchiveUrl string `json:"sourceArchiveUrl,omitempty"`
+
+ // SourceRepository: The hosted repository where the function is
+ // defined.
+ SourceRepository *SourceRepository `json:"sourceRepository,omitempty"`
+
+ // Status: Output only. Status of the function deployment.
+ //
+ // Possible values:
+ // "STATUS_UNSPECIFIED" - Status not specified.
+ // "READY" - Successfully deployed.
+ // "FAILED" - Not deployed correctly - behavior is undefined. The item
+ // should be updated
+ // or deleted to move it out of this state.
+ // "DEPLOYING" - Creation or update in progress.
+ // "DELETING" - Deletion in progress.
+ Status string `json:"status,omitempty"`
+
+ // Timeout: The function execution timeout. Execution is considered
+ // failed and
+ // can be terminated if the function is not completed at the end of
+ // the
+ // timeout period. Defaults to 60 seconds.
+ Timeout string `json:"timeout,omitempty"`
+
+ // UpdateTime: Output only. The last update timestamp of a Cloud
+ // Function.
+ UpdateTime string `json:"updateTime,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AvailableMemoryMb")
+ // 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. "AvailableMemoryMb") 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 *CloudFunction) MarshalJSON() ([]byte, error) {
+ type noMethod CloudFunction
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// EventTrigger: Describes EventTrigger, used to request events be sent
+// from another
+// service.
+type EventTrigger struct {
+ // EventType: `event_type` names contain the service that is sending an
+ // event and the
+ // kind of event that was fired. Must be of the
+ // form
+ // `providers/*/eventTypes/*` e.g. Directly handle a Message published
+ // to
+ // Google Cloud Pub/Sub
+ // `providers/cloud.pubsub/eventTypes/topic.publish`
+ //
+ // Handle an object changing in Google Cloud Storage
+ // `providers/cloud.storage/eventTypes/object.change`
+ //
+ // Handle a write to the Firebase Realtime Database
+ // `providers/firebase.database/eventTypes/data.write`
+ EventType string `json:"eventType,omitempty"`
+
+ // Resource: Which instance of the source's service should send events.
+ // E.g. for Pub/Sub
+ // this would be a Pub/Sub topic at `projects/*/topics/*`. For Google
+ // Cloud
+ // Storage this would be a bucket at `projects/*/buckets/*`. For any
+ // source
+ // that only supports one instance per-project, this should be the name
+ // of the
+ // project (`projects/*`)
+ Resource string `json:"resource,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "EventType") 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. "EventType") 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 *EventTrigger) MarshalJSON() ([]byte, error) {
+ type noMethod EventTrigger
+ 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 {
+ // Url: Output only. The deployed url for the function.
+ Url string `json:"url,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Url") 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. "Url") 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 *HTTPSTrigger) MarshalJSON() ([]byte, error) {
+ type noMethod HTTPSTrigger
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListFunctionsResponse: Response for the `ListFunctions` method.
+type ListFunctionsResponse struct {
+ // Functions: The functions that match the request.
+ Functions []*CloudFunction `json:"functions,omitempty"`
+
+ // NextPageToken: If not empty, indicates that there may be more
+ // functions that match
+ // the request; this value should be passed in a
+ // new
+ // google.cloud.functions.v1beta2.ListFunctionsRequest
+ // to get more functions.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Functions") 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. "Functions") 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 *ListFunctionsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListFunctionsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListLocationsResponse: The response message for
+// Locations.ListLocations.
+type ListLocationsResponse struct {
+ // Locations: A list of locations that matches the specified filter in
+ // the request.
+ Locations []*Location `json:"locations,omitempty"`
+
+ // NextPageToken: The standard List next-page token.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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 *ListLocationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListLocationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListOperationsResponse: The response message for
+// Operations.ListOperations.
+type ListOperationsResponse struct {
+ // NextPageToken: The standard List next-page token.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Operations: A list of operations that matches the specified filter in
+ // the request.
+ Operations []*Operation `json:"operations,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 *ListOperationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListOperationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Location: A resource that represents Google Cloud Platform location.
+type Location struct {
+ // Labels: Cross-service attributes for the location. For example
+ //
+ // {"cloud.googleapis.com/region": "us-east1"}
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // LocationId: The canonical id for this location. For example:
+ // "us-east1".
+ LocationId string `json:"locationId,omitempty"`
+
+ // Metadata: Service-specific metadata. For example the available
+ // capacity at the given
+ // location.
+ Metadata googleapi.RawMessage `json:"metadata,omitempty"`
+
+ // Name: Resource name for the location, which may vary between
+ // implementations.
+ // For example: "projects/example-project/locations/us-east1"
+ Name string `json:"name,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Labels") 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. "Labels") 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 *Location) MarshalJSON() ([]byte, error) {
+ type noMethod Location
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Operation: This resource represents a long-running operation that is
+// the result of a
+// network API call.
+type Operation struct {
+ // Done: 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.
+ Done bool `json:"done,omitempty"`
+
+ // Error: The error result of the operation in case of failure or
+ // cancellation.
+ Error *Status `json:"error,omitempty"`
+
+ // Metadata: 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.
+ Metadata googleapi.RawMessage `json:"metadata,omitempty"`
+
+ // Name: 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`.
+ Name string `json:"name,omitempty"`
+
+ // Response: 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`.
+ Response googleapi.RawMessage `json:"response,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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 *Operation) MarshalJSON() ([]byte, error) {
+ type noMethod Operation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// OperationMetadataV1Beta2: Metadata describing an Operation
+type OperationMetadataV1Beta2 struct {
+ // Request: The original request that started the operation.
+ Request googleapi.RawMessage `json:"request,omitempty"`
+
+ // Target: Target of the operation - for
+ // example
+ // projects/project-1/locations/region-1/functions/function-1
+ Target string `json:"target,omitempty"`
+
+ // Type: Type of operation.
+ //
+ // Possible values:
+ // "OPERATION_UNSPECIFIED" - Unknown operation type.
+ // "CREATE_FUNCTION" - Triggered by CreateFunction call
+ // "UPDATE_FUNCTION" - Triggered by UpdateFunction call
+ // "DELETE_FUNCTION" - Triggered by DeleteFunction call.
+ Type string `json:"type,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Request") 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. "Request") 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 *OperationMetadataV1Beta2) MarshalJSON() ([]byte, error) {
+ type noMethod OperationMetadataV1Beta2
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SourceRepository: Describes the location of the function source in a
+// remote repository.
+type SourceRepository struct {
+ // Branch: The name of the branch from which the function should be
+ // fetched.
+ Branch string `json:"branch,omitempty"`
+
+ // DeployedRevision: Output only. The id of the revision that was
+ // resolved at the moment of
+ // function creation or update. For example when a user deployed from
+ // a
+ // branch, it will be the revision id of the latest change on this
+ // branch at
+ // that time. If user deployed from revision then this value will be
+ // always
+ // equal to the revision specified by the user.
+ DeployedRevision string `json:"deployedRevision,omitempty"`
+
+ // RepositoryUrl: URL to the hosted repository where the function is
+ // defined. Only paths in
+ // https://source.developers.google.com domain are supported. The path
+ // should
+ // contain the name of the repository.
+ RepositoryUrl string `json:"repositoryUrl,omitempty"`
+
+ // Revision: The id of the revision that captures the state of the
+ // repository from
+ // which the function should be fetched.
+ Revision string `json:"revision,omitempty"`
+
+ // SourcePath: The path within the repository where the function is
+ // defined. The path
+ // should point to the directory where Cloud Functions files are
+ // located. Use
+ // "/" if the function is defined directly in the root directory of
+ // a
+ // repository.
+ SourcePath string `json:"sourcePath,omitempty"`
+
+ // Tag: The name of the tag that captures the state of the repository
+ // from
+ // which the function should be fetched.
+ Tag string `json:"tag,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Branch") 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. "Branch") 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 *SourceRepository) MarshalJSON() ([]byte, error) {
+ type noMethod SourceRepository
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Status: 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:
+//
+// - Simple to use and understand for most users
+// - Flexible enough to meet unexpected needs
+//
+// # Overview
+//
+// The `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` which can be used for common error
+// conditions.
+//
+// # Language mapping
+//
+// The `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 uses
+//
+// The 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:
+//
+// - Partial 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.
+//
+// - Workflow errors. A typical workflow has multiple steps. Each step
+// may
+// have a `Status` message for error reporting purpose.
+//
+// - Batch 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.
+//
+// - Asynchronous 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.
+//
+// - Logging. If some API errors are stored in logs, the message
+// `Status` could
+// be used directly after any stripping needed for security/privacy
+// reasons.
+type Status struct {
+ // Code: The status code, which should be an enum value of
+ // google.rpc.Code.
+ Code int64 `json:"code,omitempty"`
+
+ // Details: A list of messages that carry the error details. There will
+ // be a
+ // common set of message types for APIs to use.
+ Details []googleapi.RawMessage `json:"details,omitempty"`
+
+ // Message: 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.
+ Message string `json:"message,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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 *Status) MarshalJSON() ([]byte, error) {
+ type noMethod Status
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "cloudfunctions.operations.get":
+
+type OperationsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: 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.
+func (r *OperationsService) Get(name string) *OperationsGetCall {
+ c := &OperationsGetCall{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 *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall {
+ 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 *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall {
+ 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 *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall {
+ 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 *OperationsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *OperationsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1beta2/{+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 "cloudfunctions.operations.get" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.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 *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, 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 := &Operation{
+ 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 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": "v1beta2/operations/{operationsId}",
+ // "httpMethod": "GET",
+ // "id": "cloudfunctions.operations.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the operation resource.",
+ // "location": "path",
+ // "pattern": "^operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.operations.list":
+
+type OperationsListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: 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 below allows API services to override the
+// binding
+// to use different resource name schemes, such as `users/*/operations`.
+func (r *OperationsService) List() *OperationsListCall {
+ c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// Filter sets the optional parameter "filter": The standard list
+// filter.
+func (c *OperationsListCall) Filter(filter string) *OperationsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// Name sets the optional parameter "name": The name of the operation
+// collection.
+func (c *OperationsListCall) Name(name string) *OperationsListCall {
+ c.urlParams_.Set("name", name)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The standard list
+// page size.
+func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The standard list
+// page token.
+func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall {
+ 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 *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall {
+ 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 *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall {
+ 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 *OperationsListCall) Context(ctx context.Context) *OperationsListCall {
+ 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 *OperationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *OperationsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1beta2/operations")
+ 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 "cloudfunctions.operations.list" call.
+// Exactly one of *ListOperationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListOperationsResponse.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 *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, 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 := &ListOperationsResponse{
+ 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 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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ // "flatPath": "v1beta2/operations",
+ // "httpMethod": "GET",
+ // "id": "cloudfunctions.operations.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "filter": {
+ // "description": "The standard list filter.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name of the operation collection.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The standard list page size.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "The standard list page token.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/operations",
+ // "response": {
+ // "$ref": "ListOperationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) 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 "cloudfunctions.projects.locations.list":
+
+type ProjectsLocationsListCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists information about the supported locations for this
+// service.
+func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall {
+ c := &ProjectsLocationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Filter sets the optional parameter "filter": The standard list
+// filter.
+func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The standard list
+// page size.
+func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The standard list
+// page token.
+func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1beta2/{+name}/locations")
+ 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 "cloudfunctions.projects.locations.list" call.
+// Exactly one of *ListLocationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListLocationsResponse.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 *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, 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 := &ListLocationsResponse{
+ 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 information about the supported locations for this service.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations",
+ // "httpMethod": "GET",
+ // "id": "cloudfunctions.projects.locations.list",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "The standard list filter.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The resource that owns the locations collection, if applicable.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The standard list page size.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "The standard list page token.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}/locations",
+ // "response": {
+ // "$ref": "ListLocationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) 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 "cloudfunctions.projects.locations.functions.call":
+
+type ProjectsLocationsFunctionsCallCall struct {
+ s *Service
+ name string
+ callfunctionrequest *CallFunctionRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Call: Invokes synchronously deployed function. To be used for
+// testing, very
+// limited traffic allowed.
+func (r *ProjectsLocationsFunctionsService) Call(name string, callfunctionrequest *CallFunctionRequest) *ProjectsLocationsFunctionsCallCall {
+ c := &ProjectsLocationsFunctionsCallCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.callfunctionrequest = callfunctionrequest
+ 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 *ProjectsLocationsFunctionsCallCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsCallCall {
+ 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 *ProjectsLocationsFunctionsCallCall) Context(ctx context.Context) *ProjectsLocationsFunctionsCallCall {
+ 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 *ProjectsLocationsFunctionsCallCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsCallCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.callfunctionrequest)
+ 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}:call")
+ 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.call" call.
+// Exactly one of *CallFunctionResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CallFunctionResponse.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 *ProjectsLocationsFunctionsCallCall) Do(opts ...googleapi.CallOption) (*CallFunctionResponse, 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 := &CallFunctionResponse{
+ 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": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call",
+ // "httpMethod": "POST",
+ // "id": "cloudfunctions.projects.locations.functions.call",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the function to be called.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}:call",
+ // "request": {
+ // "$ref": "CallFunctionRequest"
+ // },
+ // "response": {
+ // "$ref": "CallFunctionResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.projects.locations.functions.create":
+
+type ProjectsLocationsFunctionsCreateCall struct {
+ s *Service
+ location string
+ cloudfunction *CloudFunction
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a new function. If a function with the given name
+// already exists in
+// the specified project, the long running operation will
+// return
+// `ALREADY_EXISTS` error.
+func (r *ProjectsLocationsFunctionsService) Create(location string, cloudfunction *CloudFunction) *ProjectsLocationsFunctionsCreateCall {
+ c := &ProjectsLocationsFunctionsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.location = location
+ c.cloudfunction = cloudfunction
+ 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 *ProjectsLocationsFunctionsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsCreateCall {
+ 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 *ProjectsLocationsFunctionsCreateCall) Context(ctx context.Context) *ProjectsLocationsFunctionsCreateCall {
+ 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 *ProjectsLocationsFunctionsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cloudfunction)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta2/{+location}/functions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "location": c.location,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudfunctions.projects.locations.functions.create" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.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 *ProjectsLocationsFunctionsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, 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 := &Operation{
+ 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 function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ // "httpMethod": "POST",
+ // "id": "cloudfunctions.projects.locations.functions.create",
+ // "parameterOrder": [
+ // "location"
+ // ],
+ // "parameters": {
+ // "location": {
+ // "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+location}/functions",
+ // "request": {
+ // "$ref": "CloudFunction"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.projects.locations.functions.delete":
+
+type ProjectsLocationsFunctionsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a function with the given name from the specified
+// project. If the
+// given function is used by some trigger, the trigger will be updated
+// to
+// remove this function.
+func (r *ProjectsLocationsFunctionsService) Delete(name string) *ProjectsLocationsFunctionsDeleteCall {
+ c := &ProjectsLocationsFunctionsDeleteCall{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 *ProjectsLocationsFunctionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsDeleteCall {
+ 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 *ProjectsLocationsFunctionsDeleteCall) Context(ctx context.Context) *ProjectsLocationsFunctionsDeleteCall {
+ 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 *ProjectsLocationsFunctionsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsDeleteCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta2/{+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 "cloudfunctions.projects.locations.functions.delete" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.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 *ProjectsLocationsFunctionsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, 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 := &Operation{
+ 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 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.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ // "httpMethod": "DELETE",
+ // "id": "cloudfunctions.projects.locations.functions.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the function which should be deleted.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}",
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.projects.locations.functions.get":
+
+type ProjectsLocationsFunctionsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns a function with the given name from the requested
+// project.
+func (r *ProjectsLocationsFunctionsService) Get(name string) *ProjectsLocationsFunctionsGetCall {
+ c := &ProjectsLocationsFunctionsGetCall{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 *ProjectsLocationsFunctionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsGetCall {
+ 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 *ProjectsLocationsFunctionsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsFunctionsGetCall {
+ 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 *ProjectsLocationsFunctionsGetCall) Context(ctx context.Context) *ProjectsLocationsFunctionsGetCall {
+ 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 *ProjectsLocationsFunctionsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1beta2/{+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 "cloudfunctions.projects.locations.functions.get" call.
+// Exactly one of *CloudFunction or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CloudFunction.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 *ProjectsLocationsFunctionsGetCall) Do(opts ...googleapi.CallOption) (*CloudFunction, 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 := &CloudFunction{
+ 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 function with the given name from the requested project.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ // "httpMethod": "GET",
+ // "id": "cloudfunctions.projects.locations.functions.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the function which details should be obtained.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}",
+ // "response": {
+ // "$ref": "CloudFunction"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudfunctions.projects.locations.functions.list":
+
+type ProjectsLocationsFunctionsListCall struct {
+ s *Service
+ location string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Returns a list of functions that belong to the requested
+// project.
+func (r *ProjectsLocationsFunctionsService) List(location string) *ProjectsLocationsFunctionsListCall {
+ c := &ProjectsLocationsFunctionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.location = location
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Maximum number of
+// functions to return per call.
+func (c *ProjectsLocationsFunctionsListCall) PageSize(pageSize int64) *ProjectsLocationsFunctionsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The value returned
+// by the last
+// `ListFunctionsResponse`; indicates that
+// this is a continuation of a prior `ListFunctions` call, and that
+// the
+// system should return the next page of data.
+func (c *ProjectsLocationsFunctionsListCall) PageToken(pageToken string) *ProjectsLocationsFunctionsListCall {
+ 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 *ProjectsLocationsFunctionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsListCall {
+ 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 *ProjectsLocationsFunctionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsFunctionsListCall {
+ 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 *ProjectsLocationsFunctionsListCall) Context(ctx context.Context) *ProjectsLocationsFunctionsListCall {
+ 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 *ProjectsLocationsFunctionsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1beta2/{+location}/functions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "location": c.location,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudfunctions.projects.locations.functions.list" call.
+// Exactly one of *ListFunctionsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListFunctionsResponse.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 *ProjectsLocationsFunctionsListCall) Do(opts ...googleapi.CallOption) (*ListFunctionsResponse, 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 := &ListFunctionsResponse{
+ 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 list of functions that belong to the requested project.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions",
+ // "httpMethod": "GET",
+ // "id": "cloudfunctions.projects.locations.functions.list",
+ // "parameterOrder": [
+ // "location"
+ // ],
+ // "parameters": {
+ // "location": {
+ // "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "Maximum number of functions to return per call.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+location}/functions",
+ // "response": {
+ // "$ref": "ListFunctionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsFunctionsListCall) Pages(ctx context.Context, f func(*ListFunctionsResponse) 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 "cloudfunctions.projects.locations.functions.update":
+
+type ProjectsLocationsFunctionsUpdateCall struct {
+ s *Service
+ name string
+ cloudfunction *CloudFunction
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Update: Updates existing function.
+func (r *ProjectsLocationsFunctionsService) Update(name string, cloudfunction *CloudFunction) *ProjectsLocationsFunctionsUpdateCall {
+ c := &ProjectsLocationsFunctionsUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.cloudfunction = cloudfunction
+ 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 *ProjectsLocationsFunctionsUpdateCall) Fields(s ...googleapi.Field) *ProjectsLocationsFunctionsUpdateCall {
+ 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 *ProjectsLocationsFunctionsUpdateCall) Context(ctx context.Context) *ProjectsLocationsFunctionsUpdateCall {
+ 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 *ProjectsLocationsFunctionsUpdateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsFunctionsUpdateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cloudfunction)
+ 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}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PUT", 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.update" call.
+// Exactly one of *Operation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *Operation.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 *ProjectsLocationsFunctionsUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, 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 := &Operation{
+ 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 existing function.",
+ // "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
+ // "httpMethod": "PUT",
+ // "id": "cloudfunctions.projects.locations.functions.update",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the function to be updated.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta2/{+name}",
+ // "request": {
+ // "$ref": "CloudFunction"
+ // },
+ // "response": {
+ // "$ref": "Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json
new file mode 100644
index 0000000..45b2989
--- /dev/null
+++ b/cloudkms/v1/cloudkms-api.json
@@ -0,0 +1,1516 @@
+{
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "locations": {
+ "resources": {
+ "keyRings": {
+ "resources": {
+ "cryptoKeys": {
+ "methods": {
+ "testIamPermissions": {
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions"
+ },
+ "decrypt": {
+ "response": {
+ "$ref": "DecryptResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "path": "v1/{+name}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ "description": "Decrypt data that was protected by Encrypt.",
+ "request": {
+ "$ref": "DecryptRequest"
+ }
+ },
+ "list": {
+ "description": "Lists CryptoKeys.",
+ "response": {
+ "$ref": "ListCryptoKeysResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list"
+ },
+ "encrypt": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "EncryptResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
+ "path": "v1/{+name}:encrypt",
+ "description": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
+ "request": {
+ "$ref": "EncryptRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "cryptoKeyId": {
+ "location": "query",
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
+ "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "request": {
+ "$ref": "CryptoKey"
+ }
+ },
+ "setIamPolicy": {
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy"
+ },
+ "updatePrimaryVersion": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the CryptoKey to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1/{+name}:updatePrimaryVersion",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "The name of the CryptoKey to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ "path": "v1/{+name}",
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
+ },
+ "patch": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ "path": "v1/{+name}",
+ "description": "Update a CryptoKey.",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}"
+ }
+ },
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "restore": {
+ "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 restore.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ "path": "v1/{+name}:restore",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared.",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ }
+ },
+ "patch": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "required": true,
+ "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",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states."
+ },
+ "get": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKeyVersion to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
+ "description": "Returns metadata for a given CryptoKeyVersion."
+ },
+ "list": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "description": "Lists CryptoKeyVersions.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCryptoKeyVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions"
+ },
+ "create": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED."
+ },
+ "destroy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "path": "v1/{+name}:destroy",
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "methods": {
+ "list": {
+ "description": "Lists KeyRings.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListKeyRingsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ "id": "cloudkms.projects.locations.keyRings.list",
+ "path": "v1/{+parent}/keyRings"
+ },
+ "create": {
+ "id": "cloudkms.projects.locations.keyRings.create",
+ "path": "v1/{+parent}/keyRings",
+ "description": "Create a new KeyRing in a given Project and Location.",
+ "request": {
+ "$ref": "KeyRing"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ "required": true,
+ "type": "string"
+ },
+ "keyRingId": {
+ "location": "query",
+ "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings"
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.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",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "get": {
+ "description": "Returns metadata for a given KeyRing.",
+ "response": {
+ "$ref": "KeyRing"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "The name of the KeyRing to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.get"
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.testIamPermissions"
+ }
+ }
+ }
+ },
+ "methods": {
+ "list": {
+ "description": "Lists information about the supported locations for this service.",
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/locations",
+ "path": "v1/{+name}/locations",
+ "id": "cloudkms.projects.locations.list"
+ },
+ "get": {
+ "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": "v1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1/{+name}",
+ "id": "cloudkms.projects.locations.get",
+ "description": "Get information about a location."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://cloudkms.googleapis.com/",
+ "servicePath": "",
+ "description": "Manages encryption for your cloud services the same way you do on-premise. You can generate, use, rotate, and destroy AES256 encryption keys.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "cloudkms:v1",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "revision": "20170301",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "properties": {
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
+ "type": "array",
+ "items": {
+ "$ref": "Rule"
+ }
+ }
+ },
+ "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": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "KeyRing": {
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this KeyRing was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ }
+ },
+ "id": "KeyRing",
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object"
+ },
+ "EncryptResponse": {
+ "properties": {
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse",
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "type": "object"
+ },
+ "UpdateCryptoKeyPrimaryVersionRequest": {
+ "properties": {
+ "cryptoKeyVersionId": {
+ "description": "The id of the child CryptoKeyVersion to use as primary.",
+ "type": "string"
+ }
+ },
+ "id": "UpdateCryptoKeyPrimaryVersionRequest",
+ "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
+ "type": "object"
+ },
+ "RestoreCryptoKeyVersionRequest": {
+ "properties": {},
+ "id": "RestoreCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.",
+ "type": "object"
+ },
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "type": "object",
+ "properties": {},
+ "id": "DataAccessOptions"
+ },
+ "ListKeyRingsResponse": {
+ "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": {
+ "description": "The total number of KeyRings that matched the query.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "keyRings": {
+ "description": "The list of KeyRings.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRing"
+ }
+ }
+ },
+ "id": "ListKeyRingsResponse",
+ "description": "Response message for KeyManagementService.ListKeyRings.",
+ "type": "object"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig"
+ },
+ "CryptoKeyVersion": {
+ "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.",
+ "type": "object",
+ "properties": {
+ "state": {
+ "enum": [
+ "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
+ "ENABLED",
+ "DISABLED",
+ "DESTROYED",
+ "DESTROY_SCHEDULED"
+ ],
+ "description": "The current state of the CryptoKeyVersion.",
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "This version may be used in Encrypt and\nDecrypt requests.",
+ "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
+ "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
+ "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
+ ]
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "type": "string"
+ },
+ "destroyEventTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "destroyTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKeyVersion"
+ },
+ "CloudAuditOptions": {
+ "properties": {},
+ "id": "CloudAuditOptions",
+ "description": "Write a Cloud Audit log",
+ "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* `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"
+ },
+ "EncryptRequest": {
+ "description": "Request message for KeyManagementService.Encrypt.",
+ "type": "object",
+ "properties": {
+ "plaintext": {
+ "description": "Required. The data to encrypt. Must be no larger than 64KiB.",
+ "format": "byte",
+ "type": "string"
+ },
+ "additionalAuthenticatedData": {
+ "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EncryptRequest"
+ },
+ "ListCryptoKeyVersionsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeyVersions that matched the\nquery.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cryptoKeyVersions": {
+ "description": "The list of CryptoKeyVersions.",
+ "type": "array",
+ "items": {
+ "$ref": "CryptoKeyVersion"
+ }
+ }
+ },
+ "id": "ListCryptoKeyVersionsResponse",
+ "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
+ "type": "object"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "DestroyCryptoKeyVersionRequest": {
+ "properties": {},
+ "id": "DestroyCryptoKeyVersionRequest",
+ "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.",
+ "type": "object"
+ },
+ "Rule": {
+ "description": "A rule to be applied in a Policy.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
+ }
+ },
+ "logConfig": {
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
+ "type": "array",
+ "items": {
+ "$ref": "LogConfig"
+ }
+ },
+ "in": {
+ "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "permissions": {
+ "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "action": {
+ "enum": [
+ "NO_ACTION",
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG"
+ ],
+ "description": "Required",
+ "type": "string",
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ]
+ },
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Rule"
+ },
+ "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": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "primary": {
+ "$ref": "CryptoKeyVersion",
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion."
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKey"
+ },
+ "LogConfig": {
+ "properties": {
+ "counter": {
+ "$ref": "CounterOptions",
+ "description": "Counter options."
+ },
+ "dataAccess": {
+ "description": "Data access options.",
+ "$ref": "DataAccessOptions"
+ },
+ "cloudAudit": {
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
+ }
+ },
+ "id": "LogConfig",
+ "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ },
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "DecryptRequest": {
+ "properties": {
+ "ciphertext": {
+ "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
+ "format": "byte",
+ "type": "string"
+ },
+ "additionalAuthenticatedData": {
+ "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "DecryptRequest",
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "type": "object"
+ },
+ "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": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ }
+ },
+ "id": "Location"
+ },
+ "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"
+ },
+ "cryptoKeys": {
+ "description": "The list of CryptoKeys.",
+ "type": "array",
+ "items": {
+ "$ref": "CryptoKey"
+ }
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeys that matched the query.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListCryptoKeysResponse"
+ },
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "iam": {
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "APPROVER",
+ "JUSTIFICATION_TYPE"
+ ],
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
+ "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
+ ]
+ },
+ "op": {
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
+ "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
+ "Subject is discharged"
+ ],
+ "enum": [
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
+ ],
+ "description": "An operator to apply the subject with.",
+ "type": "string"
+ },
+ "svc": {
+ "description": "Trusted attributes discharged by the service.",
+ "type": "string"
+ },
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ },
+ "sys": {
+ "enum": [
+ "NO_ATTR",
+ "REGION",
+ "SERVICE",
+ "NAME",
+ "IP"
+ ],
+ "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute type",
+ "Region of the resource",
+ "Service name",
+ "Resource name",
+ "IP address of the caller"
+ ]
+ }
+ },
+ "id": "Condition"
+ },
+ "CounterOptions": {
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
+ "id": "CounterOptions",
+ "description": "Options for counters",
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ]
+ }
+ },
+ "id": "AuditLogConfig"
+ },
+ "DecryptResponse": {
+ "properties": {
+ "plaintext": {
+ "description": "The decrypted data originally supplied in EncryptRequest.plaintext.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "DecryptResponse",
+ "description": "Response message for KeyManagementService.Decrypt.",
+ "type": "object"
+ }
+ },
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "Cloud KMS",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudkms.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "cloudkms",
+ "batchPath": "batch",
+ "title": "Google Cloud Key Management Service (KMS) API"
+}
diff --git a/cloudkms/v1/cloudkms-gen.go b/cloudkms/v1/cloudkms-gen.go
new file mode 100644
index 0000000..376e1fe
--- /dev/null
+++ b/cloudkms/v1/cloudkms-gen.go
@@ -0,0 +1,5090 @@
+// Package cloudkms provides access to the Google Cloud Key Management Service (KMS) API.
+//
+// See https://cloud.google.com/kms/
+//
+// Usage example:
+//
+// import "google.golang.org/api/cloudkms/v1"
+// ...
+// cloudkmsService, err := cloudkms.New(oauthHttpClient)
+package cloudkms // import "google.golang.org/api/cloudkms/v1"
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ context "golang.org/x/net/context"
+ ctxhttp "golang.org/x/net/context/ctxhttp"
+ gensupport "google.golang.org/api/gensupport"
+ googleapi "google.golang.org/api/googleapi"
+ "io"
+ "net/http"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+// Always reference these packages, just in case the auto-generated code
+// below doesn't.
+var _ = bytes.NewBuffer
+var _ = strconv.Itoa
+var _ = fmt.Sprintf
+var _ = json.NewDecoder
+var _ = io.Copy
+var _ = url.Parse
+var _ = gensupport.MarshalJSON
+var _ = googleapi.Version
+var _ = errors.New
+var _ = strings.Replace
+var _ = context.Canceled
+var _ = ctxhttp.Do
+
+const apiId = "cloudkms:v1"
+const apiName = "cloudkms"
+const apiVersion = "v1"
+const basePath = "https://cloudkms.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // View and manage your data across Google Cloud Platform services
+ CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+)
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Projects = NewProjectsService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+ GoogleClientHeaderElement string // client header fragment, for Google use only
+
+ Projects *ProjectsService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func (s *Service) clientHeader() string {
+ return gensupport.GoogleClientHeader("20170210", s.GoogleClientHeaderElement)
+}
+
+func NewProjectsService(s *Service) *ProjectsService {
+ rs := &ProjectsService{s: s}
+ rs.Locations = NewProjectsLocationsService(s)
+ return rs
+}
+
+type ProjectsService struct {
+ s *Service
+
+ Locations *ProjectsLocationsService
+}
+
+func NewProjectsLocationsService(s *Service) *ProjectsLocationsService {
+ rs := &ProjectsLocationsService{s: s}
+ rs.KeyRings = NewProjectsLocationsKeyRingsService(s)
+ return rs
+}
+
+type ProjectsLocationsService struct {
+ s *Service
+
+ KeyRings *ProjectsLocationsKeyRingsService
+}
+
+func NewProjectsLocationsKeyRingsService(s *Service) *ProjectsLocationsKeyRingsService {
+ rs := &ProjectsLocationsKeyRingsService{s: s}
+ rs.CryptoKeys = NewProjectsLocationsKeyRingsCryptoKeysService(s)
+ return rs
+}
+
+type ProjectsLocationsKeyRingsService struct {
+ s *Service
+
+ CryptoKeys *ProjectsLocationsKeyRingsCryptoKeysService
+}
+
+func NewProjectsLocationsKeyRingsCryptoKeysService(s *Service) *ProjectsLocationsKeyRingsCryptoKeysService {
+ rs := &ProjectsLocationsKeyRingsCryptoKeysService{s: s}
+ rs.CryptoKeyVersions = NewProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService(s)
+ return rs
+}
+
+type ProjectsLocationsKeyRingsCryptoKeysService struct {
+ s *Service
+
+ CryptoKeyVersions *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService
+}
+
+func NewProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService(s *Service) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService {
+ rs := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService{s: s}
+ return rs
+}
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService struct {
+ s *Service
+}
+
+// AuditConfig: Specifies the audit configuration for a service.
+// It consists of which permission types are logged, and what
+// identities, if
+// any, are exempted from logging.
+// An AuditConifg must have one or more AuditLogConfigs.
+//
+// If there are AuditConfigs for both `allServices` and a specific
+// service,
+// the union of the two AuditConfigs is used for that service: the
+// log_types
+// specified in each AuditConfig are enabled, and the exempted_members
+// in each
+// AuditConfig are exempted.
+// Example Policy with multiple AuditConfigs:
+// {
+// "audit_configs": [
+// {
+// "service": "allServices"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// },
+// {
+// "log_type": "ADMIN_READ",
+// }
+// ]
+// },
+// {
+// "service": "fooservice@googleapis.com"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// },
+// {
+// "log_type": "DATA_WRITE",
+// "exempted_members": [
+// "user:bar@gmail.com"
+// ]
+// }
+// ]
+// }
+// ]
+// }
+// For fooservice, this policy enables DATA_READ, DATA_WRITE and
+// ADMIN_READ
+// logging. It also exempts foo@gmail.com from DATA_READ logging,
+// and
+// bar@gmail.com from DATA_WRITE logging.
+type AuditConfig struct {
+ // AuditLogConfigs: The configuration for logging of each type of
+ // permission.
+ // Next ID: 4
+ AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
+
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // Service: Specifies a service that will be enabled for audit
+ // logging.
+ // For example, `resourcemanager`, `storage`, `compute`.
+ // `allServices` is a special value that covers all services.
+ Service string `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") 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. "AuditLogConfigs") 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 *AuditConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AuditLogConfig: Provides the configuration for logging a type of
+// permissions.
+// Example:
+//
+// {
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// }
+// ]
+// }
+//
+// This enables 'DATA_READ' and 'DATA_WRITE' logging, while
+// exempting
+// foo@gmail.com from DATA_READ logging.
+type AuditLogConfig struct {
+ // ExemptedMembers: Specifies the identities that do not cause logging
+ // for this type of
+ // permission.
+ // Follows the same format of Binding.members.
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // LogType: The log type that this config enables.
+ //
+ // Possible values:
+ // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
+ // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
+ // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
+ // "DATA_READ" - Data reads. Example: CloudSQL Users list
+ LogType string `json:"logType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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 *AuditLogConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditLogConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Binding: Associates `members` with a `role`.
+type Binding struct {
+ // Members: Specifies the identities requesting access for a Cloud
+ // Platform resource.
+ // `members` can have the following values:
+ //
+ // * `allUsers`: A special identifier that represents anyone who is
+ // on the internet; with or without a Google account.
+ //
+ // * `allAuthenticatedUsers`: A special identifier that represents
+ // anyone
+ // who is authenticated with a Google account or a service
+ // account.
+ //
+ // * `user:{emailid}`: An email address that represents a specific
+ // Google
+ // account. For example, `alice@gmail.com` or `joe@example.com`.
+ //
+ //
+ // * `serviceAccount:{emailid}`: An email address that represents a
+ // service
+ // account. For example,
+ // `my-other-app@appspot.gserviceaccount.com`.
+ //
+ // * `group:{emailid}`: An email address that represents a Google
+ // group.
+ // For example, `admins@example.com`.
+ //
+ // * `domain:{domain}`: A Google Apps domain name that represents all
+ // the
+ // users of that domain. For example, `google.com` or
+ // `example.com`.
+ //
+ //
+ Members []string `json:"members,omitempty"`
+
+ // Role: Role that is assigned to `members`.
+ // For example, `roles/viewer`, `roles/editor`, or
+ // `roles/owner`.
+ // Required
+ Role string `json:"role,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Members") 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. "Members") 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 *Binding) MarshalJSON() ([]byte, error) {
+ type noMethod Binding
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CloudAuditOptions: Write a Cloud Audit log
+type CloudAuditOptions struct {
+}
+
+// Condition: A condition to be met.
+type Condition struct {
+ // Iam: Trusted attributes supplied by the IAM system.
+ //
+ // Possible values:
+ // "NO_ATTR" - Default non-attribute.
+ // "AUTHORITY" - Either principal or (if present) authority selector.
+ // "ATTRIBUTION" - The principal (even if an authority selector is
+ // present), which
+ // must only be used for attribution, not authorization.
+ // "APPROVER" - An approver (distinct from the requester) that has
+ // authorized this
+ // request.
+ // When used with IN, the condition indicates that one of the
+ // approvers
+ // associated with the request matches the specified principal, or is
+ // a
+ // member of the specified group. Approvers can only grant
+ // additional
+ // access, and are thus only used in a strictly positive context
+ // (e.g. ALLOW/IN or DENY/NOT_IN).
+ // See: go/rpc-security-policy-dynamicauth.
+ // "JUSTIFICATION_TYPE" - What types of justifications have been
+ // supplied with this request.
+ // String values should match enum names from
+ // tech.iam.JustificationType,
+ // e.g. "MANUAL_STRING". It is not permitted to grant access based
+ // on
+ // the *absence* of a justification, so justification conditions can
+ // only
+ // be used in a "positive" context (e.g., ALLOW/IN or
+ // DENY/NOT_IN).
+ //
+ // Multiple justifications, e.g., a Buganizer ID and a
+ // manually-entered
+ // reason, are normal and supported.
+ Iam string `json:"iam,omitempty"`
+
+ // Op: An operator to apply the subject with.
+ //
+ // Possible values:
+ // "NO_OP" - Default no-op.
+ // "EQUALS" - DEPRECATED. Use IN instead.
+ // "NOT_EQUALS" - DEPRECATED. Use NOT_IN instead.
+ // "IN" - The condition is true if the subject (or any element of it
+ // if it is
+ // a set) matches any of the supplied values.
+ // "NOT_IN" - The condition is true if the subject (or every element
+ // of it if it is
+ // a set) matches none of the supplied values.
+ // "DISCHARGED" - Subject is discharged
+ Op string `json:"op,omitempty"`
+
+ // Svc: Trusted attributes discharged by the service.
+ Svc string `json:"svc,omitempty"`
+
+ // Sys: Trusted attributes supplied by any service that owns resources
+ // and uses
+ // the IAM system for access control.
+ //
+ // Possible values:
+ // "NO_ATTR" - Default non-attribute type
+ // "REGION" - Region of the resource
+ // "SERVICE" - Service name
+ // "NAME" - Resource name
+ // "IP" - IP address of the caller
+ Sys string `json:"sys,omitempty"`
+
+ // Value: DEPRECATED. Use 'values' instead.
+ Value string `json:"value,omitempty"`
+
+ // Values: The objects of the condition. This is mutually exclusive with
+ // 'value'.
+ Values []string `json:"values,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Iam") 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. "Iam") 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 *Condition) MarshalJSON() ([]byte, error) {
+ type noMethod Condition
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CounterOptions: Options for counters
+type CounterOptions struct {
+ // Field: The field value to attribute.
+ Field string `json:"field,omitempty"`
+
+ // Metric: The metric to update.
+ Metric string `json:"metric,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Field") 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. "Field") 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 *CounterOptions) MarshalJSON() ([]byte, error) {
+ type noMethod CounterOptions
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CryptoKey: A CryptoKey represents a logical key that can be used for
+// cryptographic
+// operations.
+//
+// A CryptoKey is made up of one or more versions, which
+// represent the actual key material used in cryptographic operations.
+type CryptoKey struct {
+ // CreateTime: Output only. The time at which this CryptoKey was
+ // created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // Name: Output only. The resource name for this CryptoKey in the
+ // format
+ // `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
+ Name string `json:"name,omitempty"`
+
+ // NextRotationTime: At next_rotation_time, the Key Management Service
+ // will automatically:
+ //
+ // 1. Create a new version of this CryptoKey.
+ // 2. Mark the new version as primary.
+ //
+ // Key rotations performed manually via
+ // CreateCryptoKeyVersion and
+ // UpdateCryptoKeyPrimaryVersion
+ // do not affect next_rotation_time.
+ NextRotationTime string `json:"nextRotationTime,omitempty"`
+
+ // Primary: Output only. A copy of the "primary" CryptoKeyVersion that
+ // will be used
+ // by Encrypt when this CryptoKey is given
+ // in EncryptRequest.name.
+ //
+ // The CryptoKey's primary version can be updated
+ // via
+ // UpdateCryptoKeyPrimaryVersion.
+ Primary *CryptoKeyVersion `json:"primary,omitempty"`
+
+ // Purpose: The immutable purpose of this CryptoKey. Currently, the only
+ // acceptable
+ // purpose is ENCRYPT_DECRYPT.
+ //
+ // Possible values:
+ // "CRYPTO_KEY_PURPOSE_UNSPECIFIED" - Not specified.
+ // "ENCRYPT_DECRYPT" - CryptoKeys with this purpose may be used
+ // with
+ // Encrypt and
+ // Decrypt.
+ Purpose string `json:"purpose,omitempty"`
+
+ // RotationPeriod: next_rotation_time will be advanced by this period
+ // when the service
+ // automatically rotates a key. Must be at least one day.
+ //
+ // If rotation_period is set, next_rotation_time must also be set.
+ RotationPeriod string `json:"rotationPeriod,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *CryptoKey) MarshalJSON() ([]byte, error) {
+ type noMethod CryptoKey
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CryptoKeyVersion: A CryptoKeyVersion represents an individual
+// cryptographic key, and the
+// associated key material.
+//
+// It can be used for cryptographic operations either directly, or via
+// its
+// parent CryptoKey, in which case the server will choose the
+// appropriate
+// version for the operation.
+type CryptoKeyVersion struct {
+ // CreateTime: Output only. The time at which this CryptoKeyVersion was
+ // created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // DestroyEventTime: Output only. The time this CryptoKeyVersion's key
+ // material was
+ // destroyed. Only present if state is
+ // DESTROYED.
+ DestroyEventTime string `json:"destroyEventTime,omitempty"`
+
+ // DestroyTime: Output only. The time this CryptoKeyVersion's key
+ // material is scheduled
+ // for destruction. Only present if state is
+ // DESTROY_SCHEDULED.
+ DestroyTime string `json:"destroyTime,omitempty"`
+
+ // Name: Output only. The resource name for this CryptoKeyVersion in the
+ // format
+ // `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersio
+ // ns/*`.
+ Name string `json:"name,omitempty"`
+
+ // State: The current state of the CryptoKeyVersion.
+ //
+ // Possible values:
+ // "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED" - Not specified.
+ // "ENABLED" - This version may be used in Encrypt and
+ // Decrypt requests.
+ // "DISABLED" - This version may not be used, but the key material is
+ // still available,
+ // and the version can be placed back into the ENABLED state.
+ // "DESTROYED" - This version is destroyed, and the key material is no
+ // longer stored.
+ // A version may not leave this state once entered.
+ // "DESTROY_SCHEDULED" - This version is scheduled for destruction,
+ // and will be destroyed soon.
+ // Call
+ // RestoreCryptoKeyVersion
+ // to put it back into the DISABLED state.
+ State string `json:"state,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *CryptoKeyVersion) MarshalJSON() ([]byte, error) {
+ type noMethod CryptoKeyVersion
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// DataAccessOptions: Write a Data Access (Gin) log
+type DataAccessOptions struct {
+}
+
+// DecryptRequest: Request message for KeyManagementService.Decrypt.
+type DecryptRequest struct {
+ // AdditionalAuthenticatedData: Optional data that must match the data
+ // originally supplied in
+ // EncryptRequest.additional_authenticated_data.
+ AdditionalAuthenticatedData string `json:"additionalAuthenticatedData,omitempty"`
+
+ // Ciphertext: Required. The encrypted data originally returned
+ // in
+ // EncryptResponse.ciphertext.
+ Ciphertext string `json:"ciphertext,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "AdditionalAuthenticatedData") 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.
+ // "AdditionalAuthenticatedData") 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 *DecryptRequest) MarshalJSON() ([]byte, error) {
+ type noMethod DecryptRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// DecryptResponse: Response message for KeyManagementService.Decrypt.
+type DecryptResponse struct {
+ // Plaintext: The decrypted data originally supplied in
+ // EncryptRequest.plaintext.
+ Plaintext string `json:"plaintext,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Plaintext") 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. "Plaintext") 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 *DecryptResponse) MarshalJSON() ([]byte, error) {
+ type noMethod DecryptResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// DestroyCryptoKeyVersionRequest: Request message for
+// KeyManagementService.DestroyCryptoKeyVersion.
+type DestroyCryptoKeyVersionRequest struct {
+}
+
+// EncryptRequest: Request message for KeyManagementService.Encrypt.
+type EncryptRequest struct {
+ // AdditionalAuthenticatedData: Optional data that, if specified, must
+ // also be provided during decryption
+ // through DecryptRequest.additional_authenticated_data. Must be
+ // no
+ // larger than 64KiB.
+ AdditionalAuthenticatedData string `json:"additionalAuthenticatedData,omitempty"`
+
+ // Plaintext: Required. The data to encrypt. Must be no larger than
+ // 64KiB.
+ Plaintext string `json:"plaintext,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "AdditionalAuthenticatedData") 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.
+ // "AdditionalAuthenticatedData") 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 *EncryptRequest) MarshalJSON() ([]byte, error) {
+ type noMethod EncryptRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// EncryptResponse: Response message for KeyManagementService.Encrypt.
+type EncryptResponse struct {
+ // Ciphertext: The encrypted data.
+ Ciphertext string `json:"ciphertext,omitempty"`
+
+ // Name: The resource name of the CryptoKeyVersion used in encryption.
+ Name string `json:"name,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Ciphertext") 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. "Ciphertext") 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 *EncryptResponse) MarshalJSON() ([]byte, error) {
+ type noMethod EncryptResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// KeyRing: A KeyRing is a toplevel logical grouping of CryptoKeys.
+type KeyRing struct {
+ // CreateTime: Output only. The time at which this KeyRing was created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // Name: Output only. The resource name for the KeyRing in the
+ // format
+ // `projects/*/locations/*/keyRings/*`.
+ Name string `json:"name,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *KeyRing) MarshalJSON() ([]byte, error) {
+ type noMethod KeyRing
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListCryptoKeyVersionsResponse: Response message for
+// KeyManagementService.ListCryptoKeyVersions.
+type ListCryptoKeyVersionsResponse struct {
+ // CryptoKeyVersions: The list of CryptoKeyVersions.
+ CryptoKeyVersions []*CryptoKeyVersion `json:"cryptoKeyVersions,omitempty"`
+
+ // NextPageToken: A token to retrieve next page of results. Pass this
+ // value in
+ // ListCryptoKeyVersionsRequest.page_token to retrieve the next page
+ // of
+ // results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // TotalSize: The total number of CryptoKeyVersions that matched
+ // the
+ // query.
+ TotalSize int64 `json:"totalSize,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CryptoKeyVersions")
+ // 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. "CryptoKeyVersions") 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 *ListCryptoKeyVersionsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListCryptoKeyVersionsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListCryptoKeysResponse: Response message for
+// KeyManagementService.ListCryptoKeys.
+type ListCryptoKeysResponse struct {
+ // CryptoKeys: The list of CryptoKeys.
+ CryptoKeys []*CryptoKey `json:"cryptoKeys,omitempty"`
+
+ // NextPageToken: A token to retrieve next page of results. Pass this
+ // value in
+ // ListCryptoKeysRequest.page_token to retrieve the next page of
+ // results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // TotalSize: The total number of CryptoKeys that matched the query.
+ TotalSize int64 `json:"totalSize,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CryptoKeys") 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. "CryptoKeys") 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 *ListCryptoKeysResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListCryptoKeysResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListKeyRingsResponse: Response message for
+// KeyManagementService.ListKeyRings.
+type ListKeyRingsResponse struct {
+ // KeyRings: The list of KeyRings.
+ KeyRings []*KeyRing `json:"keyRings,omitempty"`
+
+ // NextPageToken: A token to retrieve next page of results. Pass this
+ // value in
+ // ListKeyRingsRequest.page_token to retrieve the next page of results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // TotalSize: The total number of KeyRings that matched the query.
+ TotalSize int64 `json:"totalSize,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "KeyRings") 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. "KeyRings") 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 *ListKeyRingsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListKeyRingsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListLocationsResponse: The response message for
+// Locations.ListLocations.
+type ListLocationsResponse struct {
+ // Locations: A list of locations that matches the specified filter in
+ // the request.
+ Locations []*Location `json:"locations,omitempty"`
+
+ // NextPageToken: The standard List next-page token.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Locations") 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. "Locations") 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 *ListLocationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListLocationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Location: A resource that represents Google Cloud Platform location.
+type Location struct {
+ // Labels: Cross-service attributes for the location. For example
+ //
+ // {"cloud.googleapis.com/region": "us-east1"}
+ Labels map[string]string `json:"labels,omitempty"`
+
+ // LocationId: The canonical id for this location. For example:
+ // "us-east1".
+ LocationId string `json:"locationId,omitempty"`
+
+ // Metadata: Service-specific metadata. For example the available
+ // capacity at the given
+ // location.
+ Metadata googleapi.RawMessage `json:"metadata,omitempty"`
+
+ // Name: Resource name for the location, which may vary between
+ // implementations.
+ // For example: "projects/example-project/locations/us-east1"
+ Name string `json:"name,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Labels") 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. "Labels") 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 *Location) MarshalJSON() ([]byte, error) {
+ type noMethod Location
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// LogConfig: Specifies what kind of log the caller must write
+// Increment a streamz counter with the specified metric and field
+// names.
+//
+// Metric names should start with a '/', generally be
+// lowercase-only,
+// and end in "_count". Field names should not contain an initial
+// slash.
+// The actual exported metric names will have "/iam/policy"
+// prepended.
+//
+// Field names correspond to IAM request parameters and field values
+// are
+// their respective values.
+//
+// At present the only supported field names are
+// - "iam_principal", corresponding to IAMContext.principal;
+// - "" (empty string), resulting in one aggretated counter with no
+// field.
+//
+// Examples:
+// counter { metric: "/debug_access_count" field: "iam_principal" }
+// ==> increment counter /iam/policy/backend_debug_access_count
+// {iam_principal=[value of
+// IAMContext.principal]}
+//
+// At this time we do not support:
+// * multiple field names (though this may be supported in the future)
+// * decrementing the counter
+// * incrementing it by anything other than 1
+type LogConfig struct {
+ // CloudAudit: Cloud audit options.
+ CloudAudit *CloudAuditOptions `json:"cloudAudit,omitempty"`
+
+ // Counter: Counter options.
+ Counter *CounterOptions `json:"counter,omitempty"`
+
+ // DataAccess: Data access options.
+ DataAccess *DataAccessOptions `json:"dataAccess,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CloudAudit") 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. "CloudAudit") 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 *LogConfig) MarshalJSON() ([]byte, error) {
+ type noMethod LogConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Policy: 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**
+//
+// {
+// "bindings": [
+// {
+// "role": "roles/owner",
+// "members": [
+// "user:mike@example.com",
+// "group:admins@example.com",
+// "domain:google.com",
+//
+// "serviceAccount:my-other-app@appspot.gserviceaccount.com",
+// ]
+// },
+// {
+// "role": "roles/viewer",
+// "members": ["user:sean@example.com"]
+// }
+// ]
+// }
+//
+// For a description of IAM and its features, see the
+// [IAM developer's guide](https://cloud.google.com/iam).
+type Policy struct {
+ // AuditConfigs: Specifies cloud audit logging configuration for this
+ // policy.
+ AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
+
+ // Bindings: Associates a list of `members` to a `role`.
+ // Multiple `bindings` must not be specified for the same
+ // `role`.
+ // `bindings` with no members will result in an error.
+ Bindings []*Binding `json:"bindings,omitempty"`
+
+ // Etag: `etag` is used for optimistic concurrency control as a way to
+ // help
+ // prevent simultaneous updates of a policy from overwriting each
+ // other.
+ // It is strongly suggested that systems make use of the `etag` in
+ // the
+ // read-modify-write cycle to perform policy updates in order to avoid
+ // race
+ // conditions: An `etag` is returned in the response to `getIamPolicy`,
+ // and
+ // systems are expected to put that etag in the request to
+ // `setIamPolicy` to
+ // ensure that their change will be applied to the same version of the
+ // policy.
+ //
+ // If no `etag` is provided in the call to `setIamPolicy`, then the
+ // existing
+ // policy is overwritten blindly.
+ Etag string `json:"etag,omitempty"`
+
+ IamOwned bool `json:"iamOwned,omitempty"`
+
+ // Rules: If more than one rule is specified, the rules are applied in
+ // the following
+ // manner:
+ // - All matching LOG rules are always applied.
+ // - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ // Logging will be applied if one or more matching rule requires
+ // logging.
+ // - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ // granted.
+ // Logging will be applied if one or more matching rule requires
+ // logging.
+ // - Otherwise, if no rule applies, permission is denied.
+ Rules []*Rule `json:"rules,omitempty"`
+
+ // Version: Version of the `Policy`. The default version is 0.
+ Version int64 `json:"version,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditConfigs") 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. "AuditConfigs") 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 *Policy) MarshalJSON() ([]byte, error) {
+ type noMethod Policy
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// RestoreCryptoKeyVersionRequest: Request message for
+// KeyManagementService.RestoreCryptoKeyVersion.
+type RestoreCryptoKeyVersionRequest struct {
+}
+
+// Rule: A rule to be applied in a Policy.
+type Rule struct {
+ // Action: Required
+ //
+ // Possible values:
+ // "NO_ACTION" - Default no action.
+ // "ALLOW" - Matching 'Entries' grant access.
+ // "ALLOW_WITH_LOG" - Matching 'Entries' grant access and the caller
+ // promises to log
+ // the request per the returned log_configs.
+ // "DENY" - Matching 'Entries' deny access.
+ // "DENY_WITH_LOG" - Matching 'Entries' deny access and the caller
+ // promises to log
+ // the request per the returned log_configs.
+ // "LOG" - Matching 'Entries' tell IAM.Check callers to generate logs.
+ Action string `json:"action,omitempty"`
+
+ // Conditions: Additional restrictions that must be met
+ Conditions []*Condition `json:"conditions,omitempty"`
+
+ // Description: Human-readable description of the rule.
+ Description string `json:"description,omitempty"`
+
+ // In: If one or more 'in' clauses are specified, the rule matches
+ // if
+ // the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ In []string `json:"in,omitempty"`
+
+ // LogConfig: The config returned to callers of tech.iam.IAM.CheckPolicy
+ // for any entries
+ // that match the LOG action.
+ LogConfig []*LogConfig `json:"logConfig,omitempty"`
+
+ // NotIn: If one or more 'not_in' clauses are specified, the rule
+ // matches
+ // if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ // The format for in and not_in entries is the same as for members in
+ // a
+ // Binding (see google/iam/v1/policy.proto).
+ NotIn []string `json:"notIn,omitempty"`
+
+ // Permissions: A permission is a string of form '<service>.<resource
+ // type>.<verb>'
+ // (e.g., 'storage.buckets.list'). A value of '*' matches all
+ // permissions,
+ // and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ Permissions []string `json:"permissions,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Action") 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. "Action") 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 *Rule) MarshalJSON() ([]byte, error) {
+ type noMethod Rule
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// SetIamPolicyRequest: Request message for `SetIamPolicy` method.
+type SetIamPolicyRequest struct {
+ // Policy: 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.
+ Policy *Policy `json:"policy,omitempty"`
+
+ // UpdateMask: OPTIONAL: A FieldMask specifying which fields of the
+ // policy to modify. Only
+ // the fields in the mask will be modified. If no mask is provided, a
+ // default
+ // mask is used:
+ // paths: "bindings, etag"
+ // This field is only used by Cloud IAM.
+ UpdateMask string `json:"updateMask,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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 *SetIamPolicyRequest) MarshalJSON() ([]byte, error) {
+ type noMethod SetIamPolicyRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TestIamPermissionsRequest: Request message for `TestIamPermissions`
+// method.
+type TestIamPermissionsRequest struct {
+ // Permissions: The set of permissions to check for the `resource`.
+ // Permissions with
+ // wildcards (such as '*' or 'storage.*') are not allowed. For
+ // more
+ // information see
+ // [IAM
+ // Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ Permissions []string `json:"permissions,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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 *TestIamPermissionsRequest) MarshalJSON() ([]byte, error) {
+ type noMethod TestIamPermissionsRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// TestIamPermissionsResponse: Response message for `TestIamPermissions`
+// method.
+type TestIamPermissionsResponse struct {
+ // Permissions: A subset of `TestPermissionsRequest.permissions` that
+ // the caller is
+ // allowed.
+ Permissions []string `json:"permissions,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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 *TestIamPermissionsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod TestIamPermissionsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// UpdateCryptoKeyPrimaryVersionRequest: Request message for
+// KeyManagementService.UpdateCryptoKeyPrimaryVersion.
+type UpdateCryptoKeyPrimaryVersionRequest struct {
+ // CryptoKeyVersionId: The id of the child CryptoKeyVersion to use as
+ // primary.
+ CryptoKeyVersionId string `json:"cryptoKeyVersionId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CryptoKeyVersionId")
+ // 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. "CryptoKeyVersionId") 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 *UpdateCryptoKeyPrimaryVersionRequest) MarshalJSON() ([]byte, error) {
+ type noMethod UpdateCryptoKeyPrimaryVersionRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "cloudkms.projects.locations.get":
+
+type ProjectsLocationsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Get information about a location.
+func (r *ProjectsLocationsService) Get(name string) *ProjectsLocationsGetCall {
+ c := &ProjectsLocationsGetCall{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 *ProjectsLocationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetCall {
+ 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 *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall {
+ 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 *ProjectsLocationsGetCall) Context(ctx context.Context) *ProjectsLocationsGetCall {
+ 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 *ProjectsLocationsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "cloudkms.projects.locations.get" call.
+// Exactly one of *Location or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Location.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 *ProjectsLocationsGetCall) Do(opts ...googleapi.CallOption) (*Location, 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 := &Location{
+ 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": "Get information about a location.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Resource name for the location.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "Location"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.list":
+
+type ProjectsLocationsListCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists information about the supported locations for this
+// service.
+func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall {
+ c := &ProjectsLocationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Filter sets the optional parameter "filter": The standard list
+// filter.
+func (c *ProjectsLocationsListCall) Filter(filter string) *ProjectsLocationsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The standard list
+// page size.
+func (c *ProjectsLocationsListCall) PageSize(pageSize int64) *ProjectsLocationsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The standard list
+// page token.
+func (c *ProjectsLocationsListCall) PageToken(pageToken string) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Context(ctx context.Context) *ProjectsLocationsListCall {
+ 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 *ProjectsLocationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+name}/locations")
+ 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 "cloudkms.projects.locations.list" call.
+// Exactly one of *ListLocationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListLocationsResponse.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 *ProjectsLocationsListCall) Do(opts ...googleapi.CallOption) (*ListLocationsResponse, 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 := &ListLocationsResponse{
+ 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 information about the supported locations for this service.",
+ // "flatPath": "v1/projects/{projectsId}/locations",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.list",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "The standard list filter.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The resource that owns the locations collection, if applicable.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The standard list page size.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "The standard list page token.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}/locations",
+ // "response": {
+ // "$ref": "ListLocationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsListCall) Pages(ctx context.Context, f func(*ListLocationsResponse) 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 "cloudkms.projects.locations.keyRings.create":
+
+type ProjectsLocationsKeyRingsCreateCall struct {
+ s *Service
+ parent string
+ keyring *KeyRing
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Create a new KeyRing in a given Project and Location.
+func (r *ProjectsLocationsKeyRingsService) Create(parent string, keyring *KeyRing) *ProjectsLocationsKeyRingsCreateCall {
+ c := &ProjectsLocationsKeyRingsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.keyring = keyring
+ return c
+}
+
+// KeyRingId sets the optional parameter "keyRingId": Required. It must
+// be unique within a location and match the regular
+// expression `[a-zA-Z0-9_-]{1,63}`
+func (c *ProjectsLocationsKeyRingsCreateCall) KeyRingId(keyRingId string) *ProjectsLocationsKeyRingsCreateCall {
+ c.urlParams_.Set("keyRingId", keyRingId)
+ 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 *ProjectsLocationsKeyRingsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCreateCall {
+ 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 *ProjectsLocationsKeyRingsCreateCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCreateCall {
+ 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 *ProjectsLocationsKeyRingsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.keyring)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/keyRings")
+ 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 "cloudkms.projects.locations.keyRings.create" call.
+// Exactly one of *KeyRing or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *KeyRing.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 *ProjectsLocationsKeyRingsCreateCall) Do(opts ...googleapi.CallOption) (*KeyRing, 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 := &KeyRing{
+ 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": "Create a new KeyRing in a given Project and Location.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "keyRingId": {
+ // "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/keyRings",
+ // "request": {
+ // "$ref": "KeyRing"
+ // },
+ // "response": {
+ // "$ref": "KeyRing"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.get":
+
+type ProjectsLocationsKeyRingsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns metadata for a given KeyRing.
+func (r *ProjectsLocationsKeyRingsService) Get(name string) *ProjectsLocationsKeyRingsGetCall {
+ c := &ProjectsLocationsKeyRingsGetCall{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 *ProjectsLocationsKeyRingsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsGetCall {
+ 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 *ProjectsLocationsKeyRingsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsGetCall {
+ 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 *ProjectsLocationsKeyRingsGetCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsGetCall {
+ 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 *ProjectsLocationsKeyRingsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "cloudkms.projects.locations.keyRings.get" call.
+// Exactly one of *KeyRing or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *KeyRing.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 *ProjectsLocationsKeyRingsGetCall) Do(opts ...googleapi.CallOption) (*KeyRing, 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 := &KeyRing{
+ 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 metadata for a given KeyRing.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the KeyRing to get.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "KeyRing"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.getIamPolicy":
+
+type ProjectsLocationsKeyRingsGetIamPolicyCall struct {
+ s *Service
+ resource string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetIamPolicy: Gets the access control policy for a resource.
+// Returns an empty policy if the resource exists and does not have a
+// policy
+// set.
+func (r *ProjectsLocationsKeyRingsService) GetIamPolicy(resource string) *ProjectsLocationsKeyRingsGetIamPolicyCall {
+ c := &ProjectsLocationsKeyRingsGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ 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 *ProjectsLocationsKeyRingsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsGetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsGetIamPolicyCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+resource}:getIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.getIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.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 *ProjectsLocationsKeyRingsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, 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 := &Policy{
+ 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 the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.getIamPolicy",
+ // "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.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:getIamPolicy",
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.list":
+
+type ProjectsLocationsKeyRingsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists KeyRings.
+func (r *ProjectsLocationsKeyRingsService) List(parent string) *ProjectsLocationsKeyRingsListCall {
+ c := &ProjectsLocationsKeyRingsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Optional limit on
+// the number of KeyRings to include in the
+// response. Further KeyRings can subsequently be obtained by
+// including the ListKeyRingsResponse.next_page_token in a
+// subsequent
+// request. If unspecified, the server will pick an appropriate
+// default.
+func (c *ProjectsLocationsKeyRingsListCall) PageSize(pageSize int64) *ProjectsLocationsKeyRingsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Optional
+// pagination token, returned earlier
+// via
+// ListKeyRingsResponse.next_page_token.
+func (c *ProjectsLocationsKeyRingsListCall) PageToken(pageToken string) *ProjectsLocationsKeyRingsListCall {
+ 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 *ProjectsLocationsKeyRingsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsListCall {
+ 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 *ProjectsLocationsKeyRingsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsListCall {
+ 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 *ProjectsLocationsKeyRingsListCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsListCall {
+ 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 *ProjectsLocationsKeyRingsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/keyRings")
+ 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 "cloudkms.projects.locations.keyRings.list" call.
+// Exactly one of *ListKeyRingsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListKeyRingsResponse.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 *ProjectsLocationsKeyRingsListCall) Do(opts ...googleapi.CallOption) (*ListKeyRingsResponse, 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 := &ListKeyRingsResponse{
+ 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 KeyRings.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/keyRings",
+ // "response": {
+ // "$ref": "ListKeyRingsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsKeyRingsListCall) Pages(ctx context.Context, f func(*ListKeyRingsResponse) 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 "cloudkms.projects.locations.keyRings.setIamPolicy":
+
+type ProjectsLocationsKeyRingsSetIamPolicyCall struct {
+ s *Service
+ resource string
+ setiampolicyrequest *SetIamPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetIamPolicy: Sets the access control policy on the specified
+// resource. Replaces any
+// existing policy.
+func (r *ProjectsLocationsKeyRingsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsKeyRingsSetIamPolicyCall {
+ c := &ProjectsLocationsKeyRingsSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.setiampolicyrequest = setiampolicyrequest
+ 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 *ProjectsLocationsKeyRingsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsSetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsSetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsSetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsSetIamPolicyCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:setIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.setIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.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 *ProjectsLocationsKeyRingsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, 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 := &Policy{
+ 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": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:setIamPolicy",
+ // "request": {
+ // "$ref": "SetIamPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.testIamPermissions":
+
+type ProjectsLocationsKeyRingsTestIamPermissionsCall struct {
+ s *Service
+ resource string
+ testiampermissionsrequest *TestIamPermissionsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// TestIamPermissions: 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.
+func (r *ProjectsLocationsKeyRingsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsKeyRingsTestIamPermissionsCall {
+ c := &ProjectsLocationsKeyRingsTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.testiampermissionsrequest = testiampermissionsrequest
+ 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 *ProjectsLocationsKeyRingsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsTestIamPermissionsCall {
+ 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 *ProjectsLocationsKeyRingsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsTestIamPermissionsCall {
+ 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 *ProjectsLocationsKeyRingsTestIamPermissionsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsTestIamPermissionsCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:testIamPermissions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.testIamPermissions" call.
+// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *TestIamPermissionsResponse.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 *ProjectsLocationsKeyRingsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, 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 := &TestIamPermissionsResponse{
+ 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 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.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.testIamPermissions",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "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.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:testIamPermissions",
+ // "request": {
+ // "$ref": "TestIamPermissionsRequest"
+ // },
+ // "response": {
+ // "$ref": "TestIamPermissionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.create":
+
+type ProjectsLocationsKeyRingsCryptoKeysCreateCall struct {
+ s *Service
+ parent string
+ cryptokey *CryptoKey
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Create a new CryptoKey within a KeyRing.
+//
+// CryptoKey.purpose is required.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) Create(parent string, cryptokey *CryptoKey) *ProjectsLocationsKeyRingsCryptoKeysCreateCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.cryptokey = cryptokey
+ return c
+}
+
+// CryptoKeyId sets the optional parameter "cryptoKeyId": Required. It
+// must be unique within a KeyRing and match the regular
+// expression `[a-zA-Z0-9_-]{1,63}`
+func (c *ProjectsLocationsKeyRingsCryptoKeysCreateCall) CryptoKeyId(cryptoKeyId string) *ProjectsLocationsKeyRingsCryptoKeysCreateCall {
+ c.urlParams_.Set("cryptoKeyId", cryptoKeyId)
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCreateCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCreateCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCreateCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cryptokey)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/cryptoKeys")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.create" call.
+// Exactly one of *CryptoKey or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CryptoKey.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 *ProjectsLocationsKeyRingsCryptoKeysCreateCall) Do(opts ...googleapi.CallOption) (*CryptoKey, 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 := &CryptoKey{
+ 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": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "cryptoKeyId": {
+ // "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/cryptoKeys",
+ // "request": {
+ // "$ref": "CryptoKey"
+ // },
+ // "response": {
+ // "$ref": "CryptoKey"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt":
+
+type ProjectsLocationsKeyRingsCryptoKeysDecryptCall struct {
+ s *Service
+ name string
+ decryptrequest *DecryptRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Decrypt: Decrypt data that was protected by Encrypt.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) Decrypt(name string, decryptrequest *DecryptRequest) *ProjectsLocationsKeyRingsCryptoKeysDecryptCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysDecryptCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.decryptrequest = decryptrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysDecryptCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysDecryptCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.decryptrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:decrypt")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt" call.
+// Exactly one of *DecryptResponse or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *DecryptResponse.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 *ProjectsLocationsKeyRingsCryptoKeysDecryptCall) Do(opts ...googleapi.CallOption) (*DecryptResponse, 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 := &DecryptResponse{
+ 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": "Decrypt data that was protected by Encrypt.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:decrypt",
+ // "request": {
+ // "$ref": "DecryptRequest"
+ // },
+ // "response": {
+ // "$ref": "DecryptResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt":
+
+type ProjectsLocationsKeyRingsCryptoKeysEncryptCall struct {
+ s *Service
+ name string
+ encryptrequest *EncryptRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Encrypt: Encrypt data, so that it can only be recovered by a call to
+// Decrypt.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) Encrypt(name string, encryptrequest *EncryptRequest) *ProjectsLocationsKeyRingsCryptoKeysEncryptCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysEncryptCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.encryptrequest = encryptrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysEncryptCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysEncryptCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.encryptrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:encrypt")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt" call.
+// Exactly one of *EncryptResponse or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *EncryptResponse.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 *ProjectsLocationsKeyRingsCryptoKeysEncryptCall) Do(opts ...googleapi.CallOption) (*EncryptResponse, 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 := &EncryptResponse{
+ 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": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "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.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:encrypt",
+ // "request": {
+ // "$ref": "EncryptRequest"
+ // },
+ // "response": {
+ // "$ref": "EncryptResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.get":
+
+type ProjectsLocationsKeyRingsCryptoKeysGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns metadata for a given CryptoKey, as well as its
+// primary CryptoKeyVersion.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) Get(name string) *ProjectsLocationsKeyRingsCryptoKeysGetCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysGetCall{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 *ProjectsLocationsKeyRingsCryptoKeysGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsCryptoKeysGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "cloudkms.projects.locations.keyRings.cryptoKeys.get" call.
+// Exactly one of *CryptoKey or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CryptoKey.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 *ProjectsLocationsKeyRingsCryptoKeysGetCall) Do(opts ...googleapi.CallOption) (*CryptoKey, 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 := &CryptoKey{
+ 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 metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the CryptoKey to get.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "CryptoKey"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy":
+
+type ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall struct {
+ s *Service
+ resource string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetIamPolicy: Gets the access control policy for a resource.
+// Returns an empty policy if the resource exists and does not have a
+// policy
+// set.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) GetIamPolicy(resource string) *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+resource}:getIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.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 *ProjectsLocationsKeyRingsCryptoKeysGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, 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 := &Policy{
+ 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 the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ // "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.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:getIamPolicy",
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.list":
+
+type ProjectsLocationsKeyRingsCryptoKeysListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists CryptoKeys.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) List(parent string) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Optional limit on
+// the number of CryptoKeys to include in the
+// response. Further CryptoKeys can subsequently be obtained
+// by
+// including the ListCryptoKeysResponse.next_page_token in a
+// subsequent
+// request. If unspecified, the server will pick an appropriate
+// default.
+func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) PageSize(pageSize int64) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Optional
+// pagination token, returned earlier
+// via
+// ListCryptoKeysResponse.next_page_token.
+func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) PageToken(pageToken string) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysListCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysListCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysListCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/cryptoKeys")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.list" call.
+// Exactly one of *ListCryptoKeysResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListCryptoKeysResponse.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 *ProjectsLocationsKeyRingsCryptoKeysListCall) Do(opts ...googleapi.CallOption) (*ListCryptoKeysResponse, 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 := &ListCryptoKeysResponse{
+ 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 CryptoKeys.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/cryptoKeys",
+ // "response": {
+ // "$ref": "ListCryptoKeysResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsKeyRingsCryptoKeysListCall) Pages(ctx context.Context, f func(*ListCryptoKeysResponse) 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 "cloudkms.projects.locations.keyRings.cryptoKeys.patch":
+
+type ProjectsLocationsKeyRingsCryptoKeysPatchCall struct {
+ s *Service
+ name string
+ cryptokey *CryptoKey
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Patch: Update a CryptoKey.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) Patch(name string, cryptokey *CryptoKey) *ProjectsLocationsKeyRingsCryptoKeysPatchCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.cryptokey = cryptokey
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Required list of
+// fields to be updated in this request.
+func (c *ProjectsLocationsKeyRingsCryptoKeysPatchCall) UpdateMask(updateMask string) *ProjectsLocationsKeyRingsCryptoKeysPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysPatchCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysPatchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysPatchCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cryptokey)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+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 "cloudkms.projects.locations.keyRings.cryptoKeys.patch" call.
+// Exactly one of *CryptoKey or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CryptoKey.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 *ProjectsLocationsKeyRingsCryptoKeysPatchCall) Do(opts ...googleapi.CallOption) (*CryptoKey, 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 := &CryptoKey{
+ 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": "Update a CryptoKey.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ // "httpMethod": "PATCH",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Required list of fields to be updated in this request.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "request": {
+ // "$ref": "CryptoKey"
+ // },
+ // "response": {
+ // "$ref": "CryptoKey"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy":
+
+type ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall struct {
+ s *Service
+ resource string
+ setiampolicyrequest *SetIamPolicyRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetIamPolicy: Sets the access control policy on the specified
+// resource. Replaces any
+// existing policy.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.setiampolicyrequest = setiampolicyrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.setiampolicyrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:setIamPolicy")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy" call.
+// Exactly one of *Policy or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Policy.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 *ProjectsLocationsKeyRingsCryptoKeysSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, 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 := &Policy{
+ 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": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "parameters": {
+ // "resource": {
+ // "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:setIamPolicy",
+ // "request": {
+ // "$ref": "SetIamPolicyRequest"
+ // },
+ // "response": {
+ // "$ref": "Policy"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions":
+
+type ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall struct {
+ s *Service
+ resource string
+ testiampermissionsrequest *TestIamPermissionsRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// TestIamPermissions: 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.
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.resource = resource
+ c.testiampermissionsrequest = testiampermissionsrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.testiampermissionsrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+resource}:testIamPermissions")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("POST", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "resource": c.resource,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions" call.
+// Exactly one of *TestIamPermissionsResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *TestIamPermissionsResponse.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 *ProjectsLocationsKeyRingsCryptoKeysTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, 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 := &TestIamPermissionsResponse{
+ 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 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.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ // "parameterOrder": [
+ // "resource"
+ // ],
+ // "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.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+resource}:testIamPermissions",
+ // "request": {
+ // "$ref": "TestIamPermissionsRequest"
+ // },
+ // "response": {
+ // "$ref": "TestIamPermissionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion":
+
+type ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall struct {
+ s *Service
+ name string
+ updatecryptokeyprimaryversionrequest *UpdateCryptoKeyPrimaryVersionRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// UpdatePrimaryVersion: Update the version of a CryptoKey that will be
+// used in Encrypt
+func (r *ProjectsLocationsKeyRingsCryptoKeysService) UpdatePrimaryVersion(name string, updatecryptokeyprimaryversionrequest *UpdateCryptoKeyPrimaryVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.updatecryptokeyprimaryversionrequest = updatecryptokeyprimaryversionrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.updatecryptokeyprimaryversionrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:updatePrimaryVersion")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion" call.
+// Exactly one of *CryptoKey or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CryptoKey.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 *ProjectsLocationsKeyRingsCryptoKeysUpdatePrimaryVersionCall) Do(opts ...googleapi.CallOption) (*CryptoKey, 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 := &CryptoKey{
+ 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": "Update the version of a CryptoKey that will be used in Encrypt",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the CryptoKey to update.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:updatePrimaryVersion",
+ // "request": {
+ // "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
+ // },
+ // "response": {
+ // "$ref": "CryptoKey"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall struct {
+ s *Service
+ parent string
+ cryptokeyversion *CryptoKeyVersion
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Create a new CryptoKeyVersion in a CryptoKey.
+//
+// The server will assign the next sequential id. If unset,
+// state will be set to
+// ENABLED.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Create(parent string, cryptokeyversion *CryptoKeyVersion) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.cryptokeyversion = cryptokeyversion
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cryptokeyversion)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/cryptoKeyVersions")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create" call.
+// Exactly one of *CryptoKeyVersion or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CryptoKeyVersion.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsCreateCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, 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 := &CryptoKeyVersion{
+ 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": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/cryptoKeyVersions",
+ // "request": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "response": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall struct {
+ s *Service
+ name string
+ destroycryptokeyversionrequest *DestroyCryptoKeyVersionRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Destroy: Schedule a CryptoKeyVersion for destruction.
+//
+// Upon calling this method, CryptoKeyVersion.state will be set
+// to
+// DESTROY_SCHEDULED
+// and destroy_time will be set to a time 24
+// hours in the future, at which point the state
+// will be changed to
+// DESTROYED, and the key
+// material will be irrevocably destroyed.
+//
+// Before the destroy_time is reached,
+// RestoreCryptoKeyVersion may be called to reverse the process.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Destroy(name string, destroycryptokeyversionrequest *DestroyCryptoKeyVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.destroycryptokeyversionrequest = destroycryptokeyversionrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.destroycryptokeyversionrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:destroy")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy" call.
+// Exactly one of *CryptoKeyVersion or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CryptoKeyVersion.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsDestroyCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, 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 := &CryptoKeyVersion{
+ 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": "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.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the CryptoKeyVersion to destroy.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:destroy",
+ // "request": {
+ // "$ref": "DestroyCryptoKeyVersionRequest"
+ // },
+ // "response": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Returns metadata for a given CryptoKeyVersion.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Get(name string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall{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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get" call.
+// Exactly one of *CryptoKeyVersion or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CryptoKeyVersion.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsGetCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, 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 := &CryptoKeyVersion{
+ 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 metadata for a given CryptoKeyVersion.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the CryptoKeyVersion to get.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists CryptoKeyVersions.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) List(parent string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Optional limit on
+// the number of CryptoKeyVersions to
+// include in the response. Further CryptoKeyVersions can
+// subsequently be obtained by including
+// the
+// ListCryptoKeyVersionsResponse.next_page_token in a subsequent
+// request.
+// If unspecified, the server will pick an appropriate default.
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) PageSize(pageSize int64) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Optional
+// pagination token, returned earlier
+// via
+// ListCryptoKeyVersionsResponse.next_page_token.
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) PageToken(pageToken string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/cryptoKeyVersions")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list" call.
+// Exactly one of *ListCryptoKeyVersionsResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *ListCryptoKeyVersionsResponse.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Do(opts ...googleapi.CallOption) (*ListCryptoKeyVersionsResponse, 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 := &ListCryptoKeyVersionsResponse{
+ 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 CryptoKeyVersions.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ // "httpMethod": "GET",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/cryptoKeyVersions",
+ // "response": {
+ // "$ref": "ListCryptoKeyVersionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsListCall) Pages(ctx context.Context, f func(*ListCryptoKeyVersionsResponse) 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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall struct {
+ s *Service
+ name string
+ cryptokeyversion *CryptoKeyVersion
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Patch: Update a CryptoKeyVersion's metadata.
+//
+// state may be changed between
+// ENABLED and
+// DISABLED using this
+// method. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion
+// to
+// move between other states.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Patch(name string, cryptokeyversion *CryptoKeyVersion) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.cryptokeyversion = cryptokeyversion
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Required list of
+// fields to be updated in this request.
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) UpdateMask(updateMask string) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.cryptokeyversion)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch" call.
+// Exactly one of *CryptoKeyVersion or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CryptoKeyVersion.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsPatchCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, 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 := &CryptoKeyVersion{
+ 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": "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.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ // "httpMethod": "PATCH",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Required list of fields to be updated in this request.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "request": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "response": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore":
+
+type ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall struct {
+ s *Service
+ name string
+ restorecryptokeyversionrequest *RestoreCryptoKeyVersionRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Restore: Restore a CryptoKeyVersion in
+// the
+// DESTROY_SCHEDULED,
+// state.
+//
+// Upon restoration of the CryptoKeyVersion, state
+// will be set to DISABLED,
+// and destroy_time will be cleared.
+func (r *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsService) Restore(name string, restorecryptokeyversionrequest *RestoreCryptoKeyVersionRequest) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall {
+ c := &ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.restorecryptokeyversionrequest = restorecryptokeyversionrequest
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Fields(s ...googleapi.Field) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Context(ctx context.Context) *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall {
+ 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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.restorecryptokeyversionrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:restore")
+ 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 "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore" call.
+// Exactly one of *CryptoKeyVersion or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *CryptoKeyVersion.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 *ProjectsLocationsKeyRingsCryptoKeysCryptoKeyVersionsRestoreCall) Do(opts ...googleapi.CallOption) (*CryptoKeyVersion, 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 := &CryptoKeyVersion{
+ 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": "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.",
+ // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ // "httpMethod": "POST",
+ // "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The resource name of the CryptoKeyVersion to restore.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:restore",
+ // "request": {
+ // "$ref": "RestoreCryptoKeyVersionRequest"
+ // },
+ // "response": {
+ // "$ref": "CryptoKeyVersion"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
diff --git a/cloudkms/v1beta1/cloudkms-api.json b/cloudkms/v1beta1/cloudkms-api.json
index 567bc31..4e5c52f 100644
--- a/cloudkms/v1beta1/cloudkms-api.json
+++ b/cloudkms/v1beta1/cloudkms-api.json
@@ -1,10 +1,343 @@
{
- "documentationLink": "https://cloud.google.com/kms/",
- "revision": "20170301",
- "id": "cloudkms:v1beta1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "Rule": {
+ "properties": {
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
+ }
+ },
+ "logConfig": {
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
+ "type": "array",
+ "items": {
+ "$ref": "LogConfig"
+ }
+ },
+ "in": {
+ "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "permissions": {
+ "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "action": {
+ "enum": [
+ "NO_ACTION",
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG"
+ ],
+ "description": "Required",
+ "type": "string",
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ]
+ }
+ },
+ "id": "Rule",
+ "description": "A rule to be applied in a Policy.",
+ "type": "object"
+ },
+ "CryptoKey": {
+ "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.",
+ "type": "object",
+ "properties": {
+ "purpose": {
+ "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": {
+ "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKey was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "rotationPeriod": {
+ "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "primary": {
+ "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
+ "$ref": "CryptoKeyVersion"
+ },
+ "name": {
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "type": "string"
+ }
+ },
+ "id": "CryptoKey"
+ },
+ "LogConfig": {
+ "properties": {
+ "cloudAudit": {
+ "description": "Cloud audit options.",
+ "$ref": "CloudAuditOptions"
+ },
+ "counter": {
+ "$ref": "CounterOptions",
+ "description": "Counter options."
+ },
+ "dataAccess": {
+ "description": "Data access options.",
+ "$ref": "DataAccessOptions"
+ }
+ },
+ "id": "LogConfig",
+ "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "DecryptRequest": {
+ "properties": {
+ "ciphertext": {
+ "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
+ "format": "byte",
+ "type": "string"
+ },
+ "additionalAuthenticatedData": {
+ "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "DecryptRequest",
+ "description": "Request message for KeyManagementService.Decrypt.",
+ "type": "object"
+ },
+ "Location": {
+ "description": "A resource that represents Google Cloud Platform location.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
+ "type": "object"
+ },
+ "name": {
+ "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
+ "type": "string"
+ },
+ "locationId": {
+ "description": "The canonical id for this location. For example: `\"us-east1\"`.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
+ "type": "object"
+ }
+ },
+ "id": "Location"
+ },
+ "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"
+ },
+ "cryptoKeys": {
+ "description": "The list of CryptoKeys.",
+ "type": "array",
+ "items": {
+ "$ref": "CryptoKey"
+ }
+ },
+ "totalSize": {
+ "description": "The total number of CryptoKeys that matched the query.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListCryptoKeysResponse"
+ },
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "svc": {
+ "description": "Trusted attributes discharged by the service.",
+ "type": "string"
+ },
+ "sys": {
+ "enumDescriptions": [
+ "Default non-attribute type",
+ "Region of the resource",
+ "Service name",
+ "Resource name",
+ "IP address of the caller"
+ ],
+ "enum": [
+ "NO_ATTR",
+ "REGION",
+ "SERVICE",
+ "NAME",
+ "IP"
+ ],
+ "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
+ "type": "string"
+ },
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ },
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "iam": {
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "APPROVER",
+ "JUSTIFICATION_TYPE"
+ ],
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
+ "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
+ ]
+ },
+ "op": {
+ "enum": [
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
+ ],
+ "description": "An operator to apply the subject with.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
+ "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
+ "Subject is discharged"
+ ]
+ }
+ },
+ "id": "Condition"
+ },
+ "CounterOptions": {
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
+ "id": "CounterOptions",
+ "description": "Options for counters",
+ "type": "object"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "id": "AuditLogConfig"
+ },
"DecryptResponse": {
"properties": {
"plaintext": {
@@ -31,59 +364,7 @@
},
"id": "TestIamPermissionsRequest"
},
- "EncryptResponse": {
- "description": "Response message for KeyManagementService.Encrypt.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion used in encryption.",
- "type": "string"
- },
- "ciphertext": {
- "description": "The encrypted data.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "EncryptResponse"
- },
- "KeyRing": {
- "properties": {
- "name": {
- "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time at which this KeyRing was created.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "KeyRing",
- "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
- "type": "object"
- },
- "ListLocationsResponse": {
- "description": "The response message for Locations.ListLocations.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "locations": {
- "description": "A list of locations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Location"
- }
- }
- },
- "id": "ListLocationsResponse"
- },
"Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "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.",
@@ -120,7 +401,59 @@
}
}
},
- "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"
+ },
+ "ListLocationsResponse": {
+ "description": "The response message for Locations.ListLocations.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "A list of locations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListLocationsResponse"
+ },
+ "EncryptResponse": {
+ "description": "Response message for KeyManagementService.Encrypt.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion used in encryption.",
+ "type": "string"
+ },
+ "ciphertext": {
+ "description": "The encrypted data.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "EncryptResponse"
+ },
+ "KeyRing": {
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time at which this KeyRing was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.",
+ "type": "string"
+ }
+ },
+ "id": "KeyRing",
+ "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.",
+ "type": "object"
},
"RestoreCryptoKeyVersionRequest": {
"properties": {},
@@ -139,6 +472,12 @@
"description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.",
"type": "object"
},
+ "DataAccessOptions": {
+ "properties": {},
+ "id": "DataAccessOptions",
+ "description": "Write a Data Access (Gin) log",
+ "type": "object"
+ },
"ListKeyRingsResponse": {
"properties": {
"nextPageToken": {
@@ -162,13 +501,9 @@
"description": "Response message for KeyManagementService.ListKeyRings.",
"type": "object"
},
- "DataAccessOptions": {
- "description": "Write a Data Access (Gin) log",
- "type": "object",
- "properties": {},
- "id": "DataAccessOptions"
- },
"AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
"properties": {
"exemptedMembers": {
"type": "array",
@@ -188,32 +523,13 @@
}
}
},
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object"
+ "id": "AuditConfig"
},
"CryptoKeyVersion": {
"description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.",
"type": "object",
"properties": {
- "destroyTime": {
- "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
- "format": "google-datetime",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKeyVersion was created.",
- "format": "google-datetime",
- "type": "string"
- },
"state": {
- "enumDescriptions": [
- "Not specified.",
- "This version may be used in Encrypt and\nDecrypt requests.",
- "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
- "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
- "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
- ],
"enum": [
"CRYPTO_KEY_VERSION_STATE_UNSPECIFIED",
"ENABLED",
@@ -222,7 +538,14 @@
"DESTROY_SCHEDULED"
],
"description": "The current state of the CryptoKeyVersion.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Not specified.",
+ "This version may be used in Encrypt and\nDecrypt requests.",
+ "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.",
+ "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.",
+ "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state."
+ ]
},
"name": {
"description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
@@ -232,15 +555,25 @@
"description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.",
"format": "google-datetime",
"type": "string"
+ },
+ "destroyTime": {
+ "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Output only. The time at which this CryptoKeyVersion was created.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "CryptoKeyVersion"
},
"CloudAuditOptions": {
- "properties": {},
- "id": "CloudAuditOptions",
"description": "Write a Cloud Audit log",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "CloudAuditOptions"
},
"Binding": {
"properties": {
@@ -261,8 +594,6 @@
"type": "object"
},
"EncryptRequest": {
- "description": "Request message for KeyManagementService.Encrypt.",
- "type": "object",
"properties": {
"plaintext": {
"description": "Required. The data to encrypt. Must be no larger than 64KiB.",
@@ -275,17 +606,14 @@
"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.",
- "type": "array",
- "items": {
- "$ref": "CryptoKeyVersion"
- }
- },
"nextPageToken": {
"description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.",
"type": "string"
@@ -294,11 +622,16 @@
"description": "The total number of CryptoKeyVersions that matched the\nquery.",
"format": "int32",
"type": "integer"
+ },
+ "cryptoKeyVersions": {
+ "description": "The list of CryptoKeyVersions.",
+ "type": "array",
+ "items": {
+ "$ref": "CryptoKeyVersion"
+ }
}
},
- "id": "ListCryptoKeyVersionsResponse",
- "description": "Response message for KeyManagementService.ListCryptoKeyVersions.",
- "type": "object"
+ "id": "ListCryptoKeyVersionsResponse"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -319,349 +652,13 @@
"type": "object",
"properties": {},
"id": "DestroyCryptoKeyVersionRequest"
- },
- "Rule": {
- "properties": {
- "permissions": {
- "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "action": {
- "enum": [
- "NO_ACTION",
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG"
- ],
- "description": "Required",
- "type": "string",
- "enumDescriptions": [
- "Default no action.",
- "Matching 'Entries' grant access.",
- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' deny access.",
- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' tell IAM.Check callers to generate logs."
- ]
- },
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Human-readable description of the rule.",
- "type": "string"
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "type": "array",
- "items": {
- "$ref": "Condition"
- }
- },
- "logConfig": {
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
- "type": "array",
- "items": {
- "$ref": "LogConfig"
- }
- },
- "in": {
- "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Rule",
- "description": "A rule to be applied in a Policy.",
- "type": "object"
- },
- "CryptoKey": {
- "properties": {
- "purpose": {
- "enum": [
- "CRYPTO_KEY_PURPOSE_UNSPECIFIED",
- "ENCRYPT_DECRYPT"
- ],
- "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt."
- ]
- },
- "nextRotationTime": {
- "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.",
- "format": "google-datetime",
- "type": "string"
- },
- "createTime": {
- "description": "Output only. The time at which this CryptoKey was created.",
- "format": "google-datetime",
- "type": "string"
- },
- "rotationPeriod": {
- "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.",
- "format": "google-duration",
- "type": "string"
- },
- "primary": {
- "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.",
- "$ref": "CryptoKeyVersion"
- },
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "type": "string"
- }
- },
- "id": "CryptoKey",
- "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"
- },
- "LogConfig": {
- "properties": {
- "counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
- },
- "dataAccess": {
- "description": "Data access options.",
- "$ref": "DataAccessOptions"
- },
- "cloudAudit": {
- "$ref": "CloudAuditOptions",
- "description": "Cloud audit options."
- }
- },
- "id": "LogConfig",
- "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
- "type": "object"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "DecryptRequest": {
- "description": "Request message for KeyManagementService.Decrypt.",
- "type": "object",
- "properties": {
- "ciphertext": {
- "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.",
- "format": "byte",
- "type": "string"
- },
- "additionalAuthenticatedData": {
- "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "DecryptRequest"
- },
- "Location": {
- "properties": {
- "name": {
- "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
- "type": "string"
- },
- "locationId": {
- "description": "The canonical id for this location. For example: `\"us-east1\"`.",
- "type": "string"
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
- "type": "object"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
- "type": "object"
- }
- },
- "id": "Location",
- "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"
- },
- "cryptoKeys": {
- "description": "The list of CryptoKeys.",
- "type": "array",
- "items": {
- "$ref": "CryptoKey"
- }
- },
- "totalSize": {
- "description": "The total number of CryptoKeys that matched the query.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ListCryptoKeysResponse"
- },
- "Condition": {
- "properties": {
- "sys": {
- "enum": [
- "NO_ATTR",
- "REGION",
- "SERVICE",
- "NAME",
- "IP"
- ],
- "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute type",
- "Region of the resource",
- "Service name",
- "Resource name",
- "IP address of the caller"
- ]
- },
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
- "type": "string"
- },
- "iam": {
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
- "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
- ],
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "APPROVER",
- "JUSTIFICATION_TYPE"
- ],
- "description": "Trusted attributes supplied by the IAM system.",
- "type": "string"
- },
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "op": {
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
- "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
- "Subject is discharged"
- ],
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "description": "An operator to apply the subject with.",
- "type": "string"
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- }
- },
- "id": "Condition",
- "description": "A condition to be met.",
- "type": "object"
- },
- "CounterOptions": {
- "properties": {
- "metric": {
- "description": "The metric to update.",
- "type": "string"
- },
- "field": {
- "description": "The field value to attribute.",
- "type": "string"
- }
- },
- "id": "CounterOptions",
- "description": "Options for counters",
- "type": "object"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string",
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ]
- }
- },
- "id": "AuditLogConfig"
}
},
- "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": {
@@ -682,493 +679,105 @@
"projects": {
"resources": {
"locations": {
- "resources": {
- "keyRings": {
- "resources": {
- "cryptoKeys": {
- "resources": {
- "cryptoKeyVersions": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListCryptoKeyVersionsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "parent": {
- "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
- "path": "v1beta1/{+parent}/cryptoKeyVersions",
- "description": "Lists CryptoKeyVersions."
- },
- "create": {
- "path": "v1beta1/{+parent}/cryptoKeyVersions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
- "request": {
- "$ref": "CryptoKeyVersion"
- },
- "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions"
- },
- "destroy": {
- "path": "v1beta1/{+name}:destroy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
- "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
- "request": {
- "$ref": "DestroyCryptoKeyVersionRequest"
- },
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion to destroy.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy"
- },
- "restore": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameters": {
- "name": {
- "description": "The resource name of the CryptoKeyVersion to restore.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
- "path": "v1beta1/{+name}:restore",
- "request": {
- "$ref": "RestoreCryptoKeyVersionRequest"
- },
- "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared."
- },
- "get": {
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
- "path": "v1beta1/{+name}",
- "description": "Returns metadata for a given CryptoKeyVersion.",
- "httpMethod": "GET",
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the CryptoKeyVersion to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}"
- },
- "patch": {
- "response": {
- "$ref": "CryptoKeyVersion"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
- "location": "path",
- "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
- "path": "v1beta1/{+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"
- }
- }
- }
- }
- },
- "methods": {
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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."
- },
- "decrypt": {
- "response": {
- "$ref": "DecryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
- "path": "v1beta1/{+name}:decrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
- "description": "Decrypt data that was protected by Encrypt.",
- "request": {
- "$ref": "DecryptRequest"
- }
- },
- "list": {
- "response": {
- "$ref": "ListCryptoKeysResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "path": "v1beta1/{+parent}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list",
- "description": "Lists CryptoKeys."
- },
- "encrypt": {
- "request": {
- "$ref": "EncryptRequest"
- },
- "description": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
- "response": {
- "$ref": "EncryptResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
- "location": "path",
- "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt",
- "path": "v1beta1/{+name}:encrypt",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt"
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.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": "CryptoKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "cryptoKeyId": {
- "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
- "type": "string",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
- "path": "v1beta1/{+parent}/cryptoKeys",
- "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
- "request": {
- "$ref": "CryptoKey"
- }
- },
- "updatePrimaryVersion": {
- "request": {
- "$ref": "UpdateCryptoKeyPrimaryVersionRequest"
- },
- "description": "Update the version of a CryptoKey that will be used in Encrypt",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "CryptoKey"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "The resource name of the CryptoKey to update.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion",
- "path": "v1beta1/{+name}:updatePrimaryVersion"
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path",
- "description": "The name of the CryptoKey to get.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1beta1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
- "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
- },
- "patch": {
- "response": {
- "$ref": "CryptoKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
- "location": "path"
- },
- "updateMask": {
- "description": "Required list of fields to be updated in this request.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
- "path": "v1beta1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch",
- "description": "Update a CryptoKey.",
- "request": {
- "$ref": "CryptoKey"
- }
- }
- }
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLocationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource that owns the locations collection, if applicable.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
}
},
+ "flatPath": "v1beta1/projects/{projectsId}/locations",
+ "path": "v1beta1/{+name}/locations",
+ "id": "cloudkms.projects.locations.list",
+ "description": "Lists information about the supported locations for this service."
+ },
+ "get": {
+ "response": {
+ "$ref": "Location"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
+ "description": "Resource name for the location.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudkms.projects.locations.get",
+ "description": "Get information about a location."
+ }
+ },
+ "resources": {
+ "keyRings": {
"methods": {
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.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."
+ },
"list": {
"parameterOrder": [
"parent"
@@ -1189,9 +798,9 @@
"location": "path"
},
"pageToken": {
+ "location": "query",
"description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
@@ -1215,11 +824,11 @@
"httpMethod": "POST",
"parameters": {
"parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "location": "path",
"description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path"
+ "type": "string"
},
"keyRingId": {
"location": "query",
@@ -1239,12 +848,6 @@
"description": "Create a new KeyRing in a given Project and Location."
},
"setIamPolicy": {
- "path": "v1beta1/{+resource}:setIamPolicy",
- "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
"response": {
"$ref": "Policy"
},
@@ -1264,7 +867,13 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy"
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"getIamPolicy": {
"httpMethod": "GET",
@@ -1276,11 +885,11 @@
],
"parameters": {
"resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1292,21 +901,20 @@
"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.",
+ "response": {
+ "$ref": "KeyRing"
+ },
"parameterOrder": [
"name"
],
"httpMethod": "GET",
- "response": {
- "$ref": "KeyRing"
- },
"parameters": {
"name": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
"description": "The name of the KeyRing to get.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -1314,106 +922,495 @@
],
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
"path": "v1beta1/{+name}",
- "id": "cloudkms.projects.locations.keyRings.get"
- },
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
+ "id": "cloudkms.projects.locations.keyRings.get",
+ "description": "Returns metadata for a given KeyRing."
+ }
+ },
+ "resources": {
+ "cryptoKeys": {
+ "resources": {
+ "cryptoKeyVersions": {
+ "methods": {
+ "restore": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the CryptoKeyVersion to restore.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore",
+ "path": "v1beta1/{+name}:restore",
+ "request": {
+ "$ref": "RestoreCryptoKeyVersionRequest"
+ },
+ "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared."
+ },
+ "get": {
+ "path": "v1beta1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get",
+ "description": "Returns metadata for a given CryptoKeyVersion.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "The name of the CryptoKeyVersion to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch",
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states."
+ },
+ "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": {
+ "location": "query",
+ "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "path": "v1beta1/{+parent}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list",
+ "description": "Lists CryptoKeyVersions."
+ },
+ "create": {
+ "request": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create",
+ "path": "v1beta1/{+parent}/cryptoKeyVersions"
+ },
+ "destroy": {
+ "path": "v1beta1/{+name}:destroy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy",
+ "request": {
+ "$ref": "DestroyCryptoKeyVersionRequest"
+ },
+ "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.",
+ "response": {
+ "$ref": "CryptoKeyVersion"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The resource name of the CryptoKeyVersion to destroy.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy"
+ }
+ }
}
},
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "cloudkms.projects.locations.keyRings.testIamPermissions"
+ "methods": {
+ "updatePrimaryVersion": {
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the CryptoKey to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion",
+ "path": "v1beta1/{+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"
+ }
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy",
+ "path": "v1beta1/{+resource}:getIamPolicy"
+ },
+ "patch": {
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "description": "Update a CryptoKey.",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Required list of fields to be updated in this request.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the CryptoKey to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get",
+ "path": "v1beta1/{+name}",
+ "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion."
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "decrypt": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "DecryptResponse"
+ },
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt",
+ "path": "v1beta1/{+name}:decrypt",
+ "request": {
+ "$ref": "DecryptRequest"
+ },
+ "description": "Decrypt data that was protected by Encrypt."
+ },
+ "list": {
+ "description": "Lists CryptoKeys.",
+ "response": {
+ "$ref": "ListCryptoKeysResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys",
+ "path": "v1beta1/{+parent}/cryptoKeys",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list"
+ },
+ "encrypt": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt",
+ "path": "v1beta1/{+name}:encrypt",
+ "description": "Encrypt data, so that it can only be recovered by a call to Decrypt.",
+ "request": {
+ "$ref": "EncryptRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "EncryptResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$",
+ "location": "path",
+ "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create",
+ "path": "v1beta1/{+parent}/cryptoKeys",
+ "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.",
+ "request": {
+ "$ref": "CryptoKey"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "CryptoKey"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "location": "path"
+ },
+ "cryptoKeyId": {
+ "location": "query",
+ "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys"
+ }
+ }
}
}
}
- },
- "methods": {
- "list": {
- "path": "v1beta1/{+name}/locations",
- "id": "cloudkms.projects.locations.list",
- "description": "Lists information about the supported locations for this service.",
- "response": {
- "$ref": "ListLocationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource that owns the locations collection, if applicable.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/locations"
- },
- "get": {
- "response": {
- "$ref": "Location"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/locations/[^/]+$",
- "location": "path",
- "description": "Resource name for the location.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudkms.projects.locations.get",
- "description": "Get information about a location."
- }
}
}
}
@@ -1426,7 +1423,12 @@
"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"
},
@@ -1443,12 +1445,9 @@
"description": "V1 error format.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -1460,20 +1459,18 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "location": "query"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "access_token": {
+ "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",
@@ -1485,20 +1482,20 @@
"type": "boolean",
"default": "true"
},
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -1510,7 +1507,10 @@
"version": "v1beta1",
"baseUrl": "https://cloudkms.googleapis.com/",
"kind": "discovery#restDescription",
- "servicePath": "",
"description": "Manages encryption for your cloud services the same way you do on-premise. You can generate, use, rotate, and destroy AES256 encryption keys.",
- "basePath": ""
+ "servicePath": "",
+ "basePath": "",
+ "id": "cloudkms:v1beta1",
+ "documentationLink": "https://cloud.google.com/kms/",
+ "revision": "20170301"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json
index 7339af0..0827eac 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -3,33 +3,304 @@
"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"
}
}
}
},
- "servicePath": "",
"kind": "discovery#restDescription",
"description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "servicePath": "",
"rootUrl": "https://cloudresourcemanager.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "cloudresourcemanager",
"batchPath": "batch",
- "revision": "20170227",
+ "revision": "20170301",
"documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v1",
"title": "Google Cloud Resource Manager API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
+ "projects": {
+ "methods": {
+ "getIamPolicy": {
+ "path": "v1/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.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{resource}:getIamPolicy"
+ },
+ "undelete": {
+ "path": "v1/projects/{projectId}:undelete",
+ "id": "cloudresourcemanager.projects.undelete",
+ "request": {
+ "$ref": "UndeleteProjectRequest"
+ },
+ "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}:undelete"
+ },
+ "get": {
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}"
+ },
+ "getAncestry": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}:getAncestry",
+ "id": "cloudresourcemanager.projects.getAncestry",
+ "path": "v1/projects/{projectId}:getAncestry",
+ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
+ "request": {
+ "$ref": "GetAncestryRequest"
+ }
+ },
+ "update": {
+ "request": {
+ "$ref": "Project"
+ },
+ "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Project"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/projects/{resource}:testIamPermissions",
+ "id": "cloudresourcemanager.projects.testIamPermissions",
+ "path": "v1/projects/{resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project."
+ },
+ "delete": {
+ "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}",
+ "path": "v1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete"
+ },
+ "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.",
+ "response": {
+ "$ref": "ListProjectsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:*|The project has a name.|\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 label.size:big|The project's label `color` has the\nvalue `red` and its label `size` has the value `big`.\n\nOptional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/projects"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/projects",
+ "id": "cloudresourcemanager.projects.create",
+ "path": "v1/projects",
+ "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.",
+ "request": {
+ "$ref": "Project"
+ }
+ },
+ "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+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last ToS-accepted owner from the policy will fail. This\nrestriction also applies to legacy projects that no longer have owners\nwho have accepted the ToS. Edits to IAM policies will be rejected until\nthe lack of a ToS-accepting owner is rectified.\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"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{resource}:setIamPolicy"
+ }
+ }
+ },
"organizations": {
"methods": {
"getIamPolicy": {
+ "id": "cloudresourcemanager.organizations.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
@@ -54,69 +325,70 @@
"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"
+ "flatPath": "v1/organizations/{organizationsId}:getIamPolicy"
},
"search": {
- "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.",
- "request": {
- "$ref": "SearchOrganizationsRequest"
- },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "SearchOrganizationsResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"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",
- "id": "cloudresourcemanager.organizations.search"
+ "request": {
+ "$ref": "SearchOrganizationsRequest"
+ },
+ "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults."
},
"get": {
- "httpMethod": "GET",
+ "path": "v1/{+name}",
+ "id": "cloudresourcemanager.organizations.get",
+ "description": "Fetches an Organization resource identified by the specified resource name.",
"response": {
"$ref": "Organization"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
- "parameters": {
- "name": {
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/organizations/{organizationsId}",
- "id": "cloudresourcemanager.organizations.get",
- "path": "v1/{+name}",
- "description": "Fetches an Organization resource identified by the specified resource name."
+ "flatPath": "v1/organizations/{organizationsId}"
},
"setIamPolicy": {
- "id": "cloudresourcemanager.organizations.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy",
+ "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".",
"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\".",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"resource": {
"pattern": "^organizations/[^/]+$",
@@ -126,16 +398,15 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/organizations/{organizationsId}:setIamPolicy"
},
"testIamPermissions": {
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
"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"
@@ -143,6 +414,10 @@
"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.",
@@ -152,23 +427,72 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/organizations/{organizationsId}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions"
+ "flatPath": "v1/organizations/{organizationsId}:testIamPermissions"
}
}
},
"liens": {
"methods": {
- "create": {
- "request": {
- "$ref": "Lien"
+ "delete": {
+ "response": {
+ "$ref": "Empty"
},
- "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.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name/identifier of the Lien to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^liens/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/liens/{liensId}",
+ "path": "v1/{+name}",
+ "id": "cloudresourcemanager.liens.delete",
+ "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`."
+ },
+ "list": {
+ "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"
+ },
+ "parameters": {
+ "pageToken": {
+ "description": "The `next_page_token` value returned from a previous List request, if any.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The maximum number of items to return. This is a suggestion for the server.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "flatPath": "v1/liens",
+ "id": "cloudresourcemanager.liens.list",
+ "path": "v1/liens"
+ },
+ "create": {
"response": {
"$ref": "Lien"
},
@@ -181,79 +505,29 @@
],
"flatPath": "v1/liens",
"path": "v1/liens",
- "id": "cloudresourcemanager.liens.create"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
+ "id": "cloudresourcemanager.liens.create",
+ "request": {
+ "$ref": "Lien"
},
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/liens/{liensId}",
- "path": "v1/{+name}",
- "id": "cloudresourcemanager.liens.delete",
- "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`."
- },
- "list": {
- "path": "v1/liens",
- "id": "cloudresourcemanager.liens.list",
- "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.",
- "response": {
- "$ref": "ListLiensResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "parent": {
- "location": "query",
- "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The `next_page_token` value returned from a previous List request, if any.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of items to return. This is a suggestion for the server.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/liens"
+ "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."
}
}
},
"operations": {
"methods": {
"get": {
- "httpMethod": "GET",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
"parameters": {
"name": {
"pattern": "^operations/.+$",
@@ -263,361 +537,45 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
"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."
- }
- }
- },
- "projects": {
- "methods": {
- "getAncestry": {
- "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "request": {
- "$ref": "GetAncestryRequest"
- },
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}:getAncestry",
- "id": "cloudresourcemanager.projects.getAncestry",
- "path": "v1/projects/{projectId}:getAncestry"
- },
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.update",
- "path": "v1/projects/{projectId}",
- "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": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
- "path": "v1/projects/{resource}:testIamPermissions"
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId"
- ],
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
- "path": "v1/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,\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."
- },
- "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": {
- "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:*|The project has a name.|\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 label.size:big|The project's label `color` has the\nvalue `red` and its label `size` has the value `big`.\n\nOptional.",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects",
- "id": "cloudresourcemanager.projects.list",
- "path": "v1/projects"
- },
- "create": {
- "id": "cloudresourcemanager.projects.create",
- "path": "v1/projects",
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{resource}:setIamPolicy",
- "path": "v1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for the specified Project. 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+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last ToS-accepted owner from the policy will fail. This\nrestriction also applies to legacy projects that no longer have owners\nwho have accepted the ToS. Edits to IAM policies will be rejected until\nthe lack of a ToS-accepting owner is rectified.\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."
- },
- "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": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{resource}:getIamPolicy",
- "id": "cloudresourcemanager.projects.getIamPolicy",
- "path": "v1/projects/{resource}: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"
- }
- },
- "undelete": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "projectId": {
- "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "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."
- },
- "get": {
- "path": "v1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get",
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "Project"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1/projects/{projectId}"
+ "id": "cloudresourcemanager.operations.get"
}
}
}
},
"parameters": {
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
+ "oauth_token": {
"location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
- "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
"$.xgafv": {
"enum": [
"1",
@@ -630,257 +588,55 @@
"v2 error format"
],
"location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
- "UndeleteProjectRequest": {
- "properties": {},
- "id": "UndeleteProjectRequest",
- "description": "The request sent to the UndeleteProject\nmethod.",
- "type": "object"
- },
- "ProjectCreationStatus": {
- "properties": {
- "ready": {
- "description": "True if the project creation process is complete.",
- "type": "boolean"
- },
- "createTime": {
- "description": "Creation time of the project creation workflow.",
- "format": "google-datetime",
- "type": "string"
- },
- "gettable": {
- "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
- "type": "boolean"
- }
- },
- "id": "ProjectCreationStatus",
- "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
- "type": "object"
- },
- "GetIamPolicyRequest": {
- "properties": {},
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object"
- },
- "TestIamPermissionsResponse": {
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object"
- },
- "OrganizationOwner": {
- "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
- "type": "object",
- "properties": {
- "directoryCustomerId": {
- "description": "The Google for Work customer id used in the Directory API.",
- "type": "string"
- }
- },
- "id": "OrganizationOwner"
- },
- "ListProjectsResponse": {
- "properties": {
- "projects": {
- "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
- "type": "array",
- "items": {
- "$ref": "Project"
- }
- },
- "nextPageToken": {
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
- "type": "string"
- }
- },
- "id": "ListProjectsResponse",
- "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"
- },
- "Project": {
- "properties": {
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "description": "An optional reference to a parent Resource.\n\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"
- },
- "createTime": {
- "description": "Creation time.\n\nRead-only.",
- "format": "google-datetime",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
- "type": "object"
- },
- "name": {
- "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
- "type": "string"
- },
- "projectId": {
- "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
- "type": "string"
- },
- "lifecycleState": {
- "enum": [
- "LIFECYCLE_STATE_UNSPECIFIED",
- "ACTIVE",
- "DELETE_REQUESTED",
- "DELETE_IN_PROGRESS"
- ],
- "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."
- ]
- }
- },
- "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"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "Organization"
- }
- }
- },
- "id": "SearchOrganizationsResponse"
- },
- "FolderOperationError": {
- "properties": {
- "errorMessageId": {
- "enumDescriptions": [
- "The error type was unrecognized or unspecified.",
- "The attempted action would violate the max folder depth constraint.",
- "The attempted action would violate the max child folders constraint.",
- "The attempted action would violate the locally-unique folder\ndisplay_name constraint.",
- "The resource being moved has been deleted.",
- "The resource a folder was being added to has been deleted.",
- "The attempted action would introduce cycle in resource path.",
- "The attempted action would move a folder that is already being moved.",
- "The folder the caller is trying to delete contains active resources."
- ],
- "enum": [
- "ERROR_TYPE_UNSPECIFIED",
- "FOLDER_HEIGHT_VIOLATION",
- "MAX_CHILD_FOLDERS_VIOLATION",
- "FOLDER_NAME_UNIQUENESS_VIOLATION",
- "RESOURCE_DELETED",
- "PARENT_DELETED",
- "CYCLE_INTRODUCED_ERROR",
- "FOLDER_ALREADY_BEING_MOVED",
- "FOLDER_TO_DELETE_NON_EMPTY"
- ],
- "description": "The type of operation error experienced.",
- "type": "string"
- }
- },
- "id": "FolderOperationError",
- "description": "A classification of the Folder Operation error.",
- "type": "object"
- },
- "Lien": {
- "properties": {
- "name": {
- "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
- "type": "string"
- },
- "reason": {
- "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
- "type": "string"
- },
- "origin": {
- "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
- "type": "string"
- },
- "restrictions": {
- "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "parent": {
- "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`",
- "type": "string"
- },
- "createTime": {
- "description": "The creation time of this Lien.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "Lien",
- "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.",
- "type": "object"
- },
- "Ancestor": {
- "description": "Identifying information for a single ancestor of a project.",
- "type": "object",
- "properties": {
- "resourceId": {
- "description": "Resource id of the ancestor.",
- "$ref": "ResourceId"
- }
- },
- "id": "Ancestor"
- },
- "SetIamPolicyRequest": {
- "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"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
"Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object",
"properties": {
- "creationTime": {
- "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
"owner": {
"description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.",
"$ref": "OrganizationOwner"
@@ -906,13 +662,18 @@
"displayName": {
"description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
"type": "string"
+ },
+ "creationTime": {
+ "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "Organization",
- "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
- "type": "object"
+ "id": "Organization"
},
"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.",
@@ -922,12 +683,44 @@
}
}
},
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
+ "id": "GetAncestryResponse"
+ },
+ "AuditLogConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "id": "AuditLogConfig",
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object"
},
"SearchOrganizationsRequest": {
"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"
@@ -936,10 +729,6 @@
"description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
"format": "int32",
"type": "integer"
- },
- "filter": {
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
}
},
"id": "SearchOrganizationsRequest",
@@ -953,6 +742,8 @@
"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).",
@@ -962,13 +753,9 @@
}
}
},
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
+ "id": "TestIamPermissionsRequest"
},
"Policy": {
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "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.",
@@ -980,6 +767,13 @@
"format": "int32",
"type": "integer"
},
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
"bindings": {
"description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
"type": "array",
@@ -988,7 +782,9 @@
}
}
},
- "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"
},
"FolderOperation": {
"properties": {
@@ -1024,22 +820,44 @@
"type": "object"
},
"ResourceId": {
+ "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
+ "type": "object",
"properties": {
- "id": {
- "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
- "type": "string"
- },
"type": {
"description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"",
"type": "string"
+ },
+ "id": {
+ "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.",
+ "type": "string"
}
},
- "id": "ResourceId",
- "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.",
- "type": "object"
+ "id": "ResourceId"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\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, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig"
},
"Operation": {
"properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -1053,8 +871,8 @@
"type": "string"
},
"error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
},
"metadata": {
"additionalProperties": {
@@ -1063,10 +881,6 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
- },
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
}
},
"id": "Operation",
@@ -1119,8 +933,6 @@
"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* `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",
@@ -1134,14 +946,262 @@
"type": "string"
}
},
- "id": "Binding"
+ "id": "Binding",
+ "description": "Associates `members` with a `role`.",
+ "type": "object"
+ },
+ "UndeleteProjectRequest": {
+ "description": "The request sent to the UndeleteProject\nmethod.",
+ "type": "object",
+ "properties": {},
+ "id": "UndeleteProjectRequest"
+ },
+ "ProjectCreationStatus": {
+ "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.",
+ "type": "object",
+ "properties": {
+ "ready": {
+ "description": "True if the project creation process is complete.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Creation time of the project creation workflow.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "gettable": {
+ "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.",
+ "type": "boolean"
+ }
+ },
+ "id": "ProjectCreationStatus"
+ },
+ "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": {
+ "properties": {},
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object"
+ },
+ "OrganizationOwner": {
+ "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
+ "type": "object",
+ "properties": {
+ "directoryCustomerId": {
+ "description": "The Google for Work customer id used in the Directory API.",
+ "type": "string"
+ }
+ },
+ "id": "OrganizationOwner"
+ },
+ "ListProjectsResponse": {
+ "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
+ },
+ "projects": {
+ "description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Project"
+ }
+ }
+ },
+ "id": "ListProjectsResponse"
+ },
+ "Project": {
+ "properties": {
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parent": {
+ "$ref": "ResourceId",
+ "description": "An optional reference to a parent Resource.\n\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": {
+ "description": "Creation time.\n\nRead-only.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.",
+ "type": "string"
+ },
+ "lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only used/useful for distinguishing\nunset values.",
+ "The normal and active state.",
+ "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.",
+ "This lifecycle state is no longer used and not returned by the API."
+ ],
+ "enum": [
+ "LIFECYCLE_STATE_UNSPECIFIED",
+ "ACTIVE",
+ "DELETE_REQUESTED",
+ "DELETE_IN_PROGRESS"
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "SearchOrganizationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.",
+ "type": "string"
+ },
+ "organizations": {
+ "description": "The list of Organizations that matched the search query, possibly\npaginated.",
+ "type": "array",
+ "items": {
+ "$ref": "Organization"
+ }
+ }
+ },
+ "id": "SearchOrganizationsResponse",
+ "description": "The response returned from the `SearchOrganizations` method.",
+ "type": "object"
+ },
+ "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."
+ ],
+ "enum": [
+ "ERROR_TYPE_UNSPECIFIED",
+ "FOLDER_HEIGHT_VIOLATION",
+ "MAX_CHILD_FOLDERS_VIOLATION",
+ "FOLDER_NAME_UNIQUENESS_VIOLATION",
+ "RESOURCE_DELETED",
+ "PARENT_DELETED",
+ "CYCLE_INTRODUCED_ERROR",
+ "FOLDER_ALREADY_BEING_MOVED",
+ "FOLDER_TO_DELETE_NON_EMPTY"
+ ],
+ "description": "The type of operation error experienced.",
+ "type": "string"
+ }
+ },
+ "id": "FolderOperationError"
+ },
+ "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": {
+ "description": "The creation time of this Lien.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "A system-generated unique identifier for this Lien.\n\nExample: `liens/1234abcd`",
+ "type": "string"
+ },
+ "reason": {
+ "description": "Concise user-visible strings indicating why an action cannot be performed\non a resource. Maximum lenth of 200 characters.\n\nExample: 'Holds production API key'",
+ "type": "string"
+ },
+ "origin": {
+ "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'",
+ "type": "string"
+ },
+ "restrictions": {
+ "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
+ "SetIamPolicyRequest": {
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "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://cloudresourcemanager.googleapis.com/"
}
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-gen.go b/cloudresourcemanager/v1/cloudresourcemanager-gen.go
index 320bf94..81ad4cf 100644
--- a/cloudresourcemanager/v1/cloudresourcemanager-gen.go
+++ b/cloudresourcemanager/v1/cloudresourcemanager-gen.go
@@ -156,6 +156,157 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// AuditConfig: Specifies the audit configuration for a service.
+// It consists of which permission types are logged, and what
+// identities, if
+// any, are exempted from logging.
+// An AuditConifg must have one or more AuditLogConfigs.
+//
+// If there are AuditConfigs for both `allServices` and a specific
+// service,
+// the union of the two AuditConfigs is used for that service: the
+// log_types
+// specified in each AuditConfig are enabled, and the exempted_members
+// in each
+// AuditConfig are exempted.
+// Example Policy with multiple AuditConfigs:
+// {
+// "audit_configs": [
+// {
+// "service": "allServices"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// },
+// {
+// "log_type": "ADMIN_READ",
+// }
+// ]
+// },
+// {
+// "service": "fooservice@googleapis.com"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// },
+// {
+// "log_type": "DATA_WRITE",
+// "exempted_members": [
+// "user:bar@gmail.com"
+// ]
+// }
+// ]
+// }
+// ]
+// }
+// For fooservice, this policy enables DATA_READ, DATA_WRITE and
+// ADMIN_READ
+// logging. It also exempts foo@gmail.com from DATA_READ logging,
+// and
+// bar@gmail.com from DATA_WRITE logging.
+type AuditConfig struct {
+ // AuditLogConfigs: The configuration for logging of each type of
+ // permission.
+ // Next ID: 4
+ AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
+
+ // Service: Specifies a service that will be enabled for audit
+ // logging.
+ // For example, `resourcemanager`, `storage`, `compute`.
+ // `allServices` is a special value that covers all services.
+ Service string `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") 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. "AuditLogConfigs") 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 *AuditConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AuditLogConfig: Provides the configuration for logging a type of
+// permissions.
+// Example:
+//
+// {
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// }
+// ]
+// }
+//
+// This enables 'DATA_READ' and 'DATA_WRITE' logging, while
+// exempting
+// foo@gmail.com from DATA_READ logging.
+type AuditLogConfig struct {
+ // ExemptedMembers: Specifies the identities that do not cause logging
+ // for this type of
+ // permission.
+ // Follows the same format of Binding.members.
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // LogType: The log type that this config enables.
+ //
+ // Possible values:
+ // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
+ // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
+ // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
+ // "DATA_READ" - Data reads. Example: CloudSQL Users list
+ LogType string `json:"logType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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 *AuditLogConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditLogConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Binding: Associates `members` with a `role`.
type Binding struct {
// Members: Specifies the identities requesting access for a Cloud
@@ -769,6 +920,10 @@
// For a description of IAM and its features, see the
// [IAM developer's guide](https://cloud.google.com/iam).
type Policy struct {
+ // AuditConfigs: Specifies cloud audit logging configuration for this
+ // policy.
+ AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
+
// Bindings: Associates a list of `members` to a `role`.
// Multiple `bindings` must not be specified for the same
// `role`.
@@ -802,7 +957,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Bindings") to
+ // ForceSendFields is a list of field names (e.g. "AuditConfigs") 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
@@ -810,10 +965,10 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Bindings") 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
+ // NullFields is a list of field names (e.g. "AuditConfigs") 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:"-"`
@@ -1141,6 +1296,15 @@
// might reject them.
Policy *Policy `json:"policy,omitempty"`
+ // UpdateMask: OPTIONAL: A FieldMask specifying which fields of the
+ // policy to modify. Only
+ // the fields in the mask will be modified. If no mask is provided, a
+ // default
+ // mask is used:
+ // paths: "bindings, etag"
+ // This field is only used by Cloud IAM.
+ UpdateMask string `json:"updateMask,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "Policy") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
index 188fbcf..8c74009 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,225 +1,22 @@
{
- "baseUrl": "https://cloudresourcemanager.googleapis.com/",
- "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"
- }
- }
- }
- },
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
- "rootUrl": "https://cloudresourcemanager.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "cloudresourcemanager",
"batchPath": "batch",
- "revision": "20170227",
- "documentationLink": "https://cloud.google.com/resource-manager",
"id": "cloudresourcemanager:v1beta1",
+ "documentationLink": "https://cloud.google.com/resource-manager",
+ "revision": "20170301",
"title": "Google Cloud Resource Manager API",
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "organizations": {
- "methods": {
- "update": {
- "description": "Updates an Organization resource identified by the specified resource name.",
- "request": {
- "$ref": "Organization"
- },
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.update"
- },
- "testIamPermissions": {
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
- "id": "cloudresourcemanager.organizations.testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions"
- },
- "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",
- "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
- "type": "string"
- },
- "pageToken": {
- "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1beta1/organizations",
- "path": "v1beta1/organizations",
- "id": "cloudresourcemanager.organizations.list",
- "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list."
- },
- "setIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
- "id": "cloudresourcemanager.organizations.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\"."
- },
- "getIamPolicy": {
- "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"
- },
- "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": {
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy",
- "id": "cloudresourcemanager.organizations.getIamPolicy",
- "path": "v1beta1/{+resource}:getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "Organization"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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": {
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path",
- "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\"."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "flatPath": "v1beta1/organizations/{organizationsId}",
- "path": "v1beta1/{+name}",
- "id": "cloudresourcemanager.organizations.get",
- "description": "Fetches an Organization resource identified by the specified resource name."
- }
- }
- },
"projects": {
"methods": {
"getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Policy"
+ },
"parameters": {
"resource": {
"location": "path",
@@ -233,39 +30,18 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta1/projects/{resource}:getIamPolicy",
- "path": "v1beta1/projects/{resource}:getIamPolicy",
"id": "cloudresourcemanager.projects.getIamPolicy",
+ "path": "v1beta1/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."
},
- "get": {
- "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.",
- "response": {
- "$ref": "Project"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only"
- ],
- "parameters": {
- "projectId": {
- "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}",
- "path": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.get"
- },
"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"
},
@@ -286,44 +62,62 @@
},
"flatPath": "v1beta1/projects/{projectId}:undelete",
"path": "v1beta1/projects/{projectId}:undelete",
- "id": "cloudresourcemanager.projects.undelete",
- "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.",
- "request": {
- "$ref": "UndeleteProjectRequest"
- }
+ "id": "cloudresourcemanager.projects.undelete"
},
- "getAncestry": {
- "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.",
- "httpMethod": "POST",
+ "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": "GetAncestryResponse"
+ "$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.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.get",
+ "path": "v1beta1/projects/{projectId}"
+ },
+ "getAncestry": {
+ "response": {
+ "$ref": "GetAncestryResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The Project ID (for example, `my-project-123`).\n\nRequired.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
- ]
+ ],
+ "flatPath": "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": {
- "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"
@@ -340,27 +134,34 @@
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "The project ID (for example, `my-project-123`).\n\nRequired.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
- }
+ },
+ "flatPath": "v1beta1/projects/{projectId}",
+ "path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.update"
},
"testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified Project.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
@@ -368,71 +169,71 @@
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1beta1/projects/{resource}:testIamPermissions",
- "id": "cloudresourcemanager.projects.testIamPermissions",
"path": "v1beta1/projects/{resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified Project."
+ "id": "cloudresourcemanager.projects.testIamPermissions"
},
"delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
- "location": "path",
"description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1beta1/projects/{projectId}",
- "id": "cloudresourcemanager.projects.delete",
"path": "v1beta1/projects/{projectId}",
+ "id": "cloudresourcemanager.projects.delete",
"description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project."
},
"list": {
- "flatPath": "v1beta1/projects",
- "path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.list",
- "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nNew Projects do not necessarily appear at the end of the list.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
"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": {
- "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:*|The project has a name.|\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 label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nOptional."
- },
- "pageToken": {
- "location": "query",
- "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.",
- "type": "string"
- },
"pageSize": {
"location": "query",
"description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.",
"format": "int32",
"type": "integer"
+ },
+ "filter": {
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:*|The project has a name.|\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 label.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\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"
}
- }
+ },
+ "flatPath": "v1beta1/projects",
+ "id": "cloudresourcemanager.projects.list",
+ "path": "v1beta1/projects",
+ "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."
},
"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"
},
@@ -450,20 +251,23 @@
],
"flatPath": "v1beta1/projects",
"path": "v1beta1/projects",
- "id": "cloudresourcemanager.projects.create",
- "request": {
- "$ref": "Project"
- },
- "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage."
+ "id": "cloudresourcemanager.projects.create"
},
"setIamPolicy": {
- "response": {
- "$ref": "Policy"
+ "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 `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+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last ToS-accepted owner from the policy will fail. This\nrestriction also applies to legacy projects that no longer have owners\nwho have accepted the ToS. Edits to IAM policies will be rejected until\nthe lack of a ToS-accepting owner is rectified.\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 roles.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
},
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "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.",
@@ -472,119 +276,312 @@
"location": "path"
}
},
+ "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
+ "id": "cloudresourcemanager.projects.setIamPolicy",
+ "path": "v1beta1/projects/{resource}:setIamPolicy"
+ }
+ }
+ },
+ "organizations": {
+ "methods": {
+ "get": {
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudresourcemanager.organizations.get",
+ "description": "Fetches an Organization resource identified by the specified resource name.",
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "organizationId": {
+ "location": "query",
+ "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "Organization"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{resource}:setIamPolicy",
- "path": "v1beta1/projects/{resource}:setIamPolicy",
- "id": "cloudresourcemanager.projects.setIamPolicy",
+ "flatPath": "v1beta1/organizations/{organizationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "cloudresourcemanager.organizations.update",
+ "request": {
+ "$ref": "Organization"
+ },
+ "description": "Updates an Organization resource identified by the specified resource name."
+ },
+ "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"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions",
+ "id": "cloudresourcemanager.organizations.testIamPermissions",
+ "path": "v1beta1/{+resource}:testIamPermissions"
+ },
+ "list": {
+ "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.",
+ "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": {
+ "description": "The maximum number of Organizations to return in the response.\nThis field is optional.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/organizations",
+ "path": "v1beta1/organizations",
+ "id": "cloudresourcemanager.organizations.list"
+ },
+ "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"
},
- "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 `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+ There must be at least one owner who has accepted the Terms of\nService (ToS) agreement in the policy. Calling `setIamPolicy()` to\nto remove the last ToS-accepted owner from the policy will fail. This\nrestriction also applies to legacy projects that no longer have owners\nwho have accepted the ToS. Edits to IAM policies will be rejected until\nthe lack of a ToS-accepting owner is rectified.\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 roles."
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "cloudresourcemanager.organizations.setIamPolicy"
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
}
}
}
},
"parameters": {
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
+ "access_token": {
+ "description": "OAuth access token.",
"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": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
- "oauth_token": {
+ "upload_protocol": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
}
},
"schemas": {
- "SetIamPolicyRequest": {
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\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": {
- "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."
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
}
},
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
+ "id": "AuditConfig"
+ },
+ "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.",
@@ -604,7 +601,24 @@
},
"id": "ListOrganizationsResponse"
},
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
"Binding": {
+ "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"members": {
@@ -619,8 +633,7 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`."
+ "id": "Binding"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -629,24 +642,26 @@
"id": "Empty"
},
"Organization": {
+ "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.",
+ "type": "object",
"properties": {
"organizationId": {
"description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.",
"type": "string"
},
"lifecycleState": {
+ "enumDescriptions": [
+ "Unspecified state. This is only useful for distinguishing unset values.",
+ "The normal and active state.",
+ "The organization has been marked for deletion by the user."
+ ],
"enum": [
"LIFECYCLE_STATE_UNSPECIFIED",
"ACTIVE",
"DELETE_REQUESTED"
],
"description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly",
- "type": "string",
- "enumDescriptions": [
- "Unspecified state. This is only useful for distinguishing unset values.",
- "The normal and active state.",
- "The organization has been marked for deletion by the user."
- ]
+ "type": "string"
},
"displayName": {
"description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly",
@@ -662,13 +677,11 @@
"description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required."
},
"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\"."
+ "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.",
- "type": "object"
+ "id": "Organization"
},
"UndeleteProjectRequest": {
"description": "The request sent to the UndeleteProject\nmethod.",
@@ -697,6 +710,7 @@
"id": "ProjectCreationStatus"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -707,8 +721,7 @@
}
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
+ "id": "TestIamPermissionsResponse"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
@@ -717,6 +730,8 @@
"id": "GetIamPolicyRequest"
},
"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.",
@@ -726,9 +741,7 @@
}
}
},
- "id": "GetAncestryResponse",
- "description": "Response from the GetAncestry method.",
- "type": "object"
+ "id": "GetAncestryResponse"
},
"OrganizationOwner": {
"description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.",
@@ -741,43 +754,64 @@
},
"id": "OrganizationOwner"
},
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
+ }
+ },
+ "id": "AuditLogConfig"
+ },
"ListProjectsResponse": {
- "id": "ListProjectsResponse",
"description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.",
"type": "object",
"properties": {
- "nextPageToken": {
- "type": "string",
- "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime."
- },
"projects": {
"description": "The list of Projects that matched the list filter. This list can\nbe paginated.",
"type": "array",
"items": {
"$ref": "Project"
}
+ },
+ "nextPageToken": {
+ "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.",
+ "type": "string"
}
- }
+ },
+ "id": "ListProjectsResponse"
},
"GetAncestryRequest": {
- "id": "GetAncestryRequest",
"description": "The request sent to the\nGetAncestry\nmethod.",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "GetAncestryRequest"
},
"Project": {
"description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.",
"type": "object",
"properties": {
- "projectNumber": {
- "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
- "format": "int64",
- "type": "string"
- },
- "parent": {
- "$ref": "ResourceId",
- "description": "An optional reference to a parent Resource.\n\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": {
"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",
@@ -799,8 +833,6 @@
"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.",
@@ -812,7 +844,18 @@
"ACTIVE",
"DELETE_REQUESTED",
"DELETE_IN_PROGRESS"
- ]
+ ],
+ "description": "The Project lifecycle state.\n\nRead-only.",
+ "type": "string"
+ },
+ "projectNumber": {
+ "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.",
+ "format": "int64",
+ "type": "string"
+ },
+ "parent": {
+ "description": "An optional reference to a parent Resource.\n\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"
}
},
"id": "Project"
@@ -831,7 +874,42 @@
},
"id": "TestIamPermissionsRequest"
},
+ "FolderOperation": {
+ "description": "Metadata describing a long running folder operation",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the folder.",
+ "type": "string"
+ },
+ "sourceParent": {
+ "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
+ "type": "string"
+ },
+ "destinationParent": {
+ "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "The type of this operation.",
+ "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": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
@@ -843,56 +921,30 @@
"format": "int32",
"type": "integer"
},
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
"bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
"type": "array",
"items": {
"$ref": "Binding"
- },
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error."
+ }
}
},
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object"
- },
- "FolderOperation": {
- "description": "Metadata describing a long running folder operation",
- "type": "object",
- "properties": {
- "destinationParent": {
- "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.",
- "type": "string"
- },
- "operationType": {
- "type": "string",
- "enumDescriptions": [
- "Operation type not specified.",
- "A create folder operation.",
- "A move folder operation."
- ],
- "enum": [
- "OPERATION_TYPE_UNSPECIFIED",
- "CREATE",
- "MOVE"
- ],
- "description": "The type of this operation."
- },
- "displayName": {
- "description": "The display name of the folder.",
- "type": "string"
- },
- "sourceParent": {
- "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.",
- "type": "string"
- }
- },
- "id": "FolderOperation"
+ "id": "Policy"
},
"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.",
@@ -914,9 +966,7 @@
"CYCLE_INTRODUCED_ERROR",
"FOLDER_ALREADY_BEING_MOVED",
"FOLDER_TO_DELETE_NON_EMPTY"
- ],
- "description": "The type of operation error experienced.",
- "type": "string"
+ ]
}
},
"id": "FolderOperationError"
@@ -935,23 +985,33 @@
}
},
"id": "ResourceId"
- },
- "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": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest",
- "version": "v1beta1"
+ "version": "v1beta1",
+ "baseUrl": "https://cloudresourcemanager.googleapis.com/",
+ "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"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://cloudresourcemanager.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "cloudresourcemanager"
}
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go b/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
index 4294719..0a329b0 100644
--- a/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
+++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-gen.go
@@ -132,6 +132,157 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// AuditConfig: Specifies the audit configuration for a service.
+// It consists of which permission types are logged, and what
+// identities, if
+// any, are exempted from logging.
+// An AuditConifg must have one or more AuditLogConfigs.
+//
+// If there are AuditConfigs for both `allServices` and a specific
+// service,
+// the union of the two AuditConfigs is used for that service: the
+// log_types
+// specified in each AuditConfig are enabled, and the exempted_members
+// in each
+// AuditConfig are exempted.
+// Example Policy with multiple AuditConfigs:
+// {
+// "audit_configs": [
+// {
+// "service": "allServices"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// },
+// {
+// "log_type": "ADMIN_READ",
+// }
+// ]
+// },
+// {
+// "service": "fooservice@googleapis.com"
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// },
+// {
+// "log_type": "DATA_WRITE",
+// "exempted_members": [
+// "user:bar@gmail.com"
+// ]
+// }
+// ]
+// }
+// ]
+// }
+// For fooservice, this policy enables DATA_READ, DATA_WRITE and
+// ADMIN_READ
+// logging. It also exempts foo@gmail.com from DATA_READ logging,
+// and
+// bar@gmail.com from DATA_WRITE logging.
+type AuditConfig struct {
+ // AuditLogConfigs: The configuration for logging of each type of
+ // permission.
+ // Next ID: 4
+ AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
+
+ // Service: Specifies a service that will be enabled for audit
+ // logging.
+ // For example, `resourcemanager`, `storage`, `compute`.
+ // `allServices` is a special value that covers all services.
+ Service string `json:"service,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AuditLogConfigs") 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. "AuditLogConfigs") 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 *AuditConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AuditLogConfig: Provides the configuration for logging a type of
+// permissions.
+// Example:
+//
+// {
+// "audit_log_configs": [
+// {
+// "log_type": "DATA_READ",
+// "exempted_members": [
+// "user:foo@gmail.com"
+// ]
+// },
+// {
+// "log_type": "DATA_WRITE",
+// }
+// ]
+// }
+//
+// This enables 'DATA_READ' and 'DATA_WRITE' logging, while
+// exempting
+// foo@gmail.com from DATA_READ logging.
+type AuditLogConfig struct {
+ // ExemptedMembers: Specifies the identities that do not cause logging
+ // for this type of
+ // permission.
+ // Follows the same format of Binding.members.
+ ExemptedMembers []string `json:"exemptedMembers,omitempty"`
+
+ // LogType: The log type that this config enables.
+ //
+ // Possible values:
+ // "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
+ // "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
+ // "DATA_WRITE" - Data writes. Example: CloudSQL Users create
+ // "DATA_READ" - Data reads. Example: CloudSQL Users list
+ LogType string `json:"logType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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 *AuditLogConfig) MarshalJSON() ([]byte, error) {
+ type noMethod AuditLogConfig
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Binding: Associates `members` with a `role`.
type Binding struct {
// Members: Specifies the identities requesting access for a Cloud
@@ -610,6 +761,10 @@
// For a description of IAM and its features, see the
// [IAM developer's guide](https://cloud.google.com/iam).
type Policy struct {
+ // AuditConfigs: Specifies cloud audit logging configuration for this
+ // policy.
+ AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
+
// Bindings: Associates a list of `members` to a `role`.
// Multiple `bindings` must not be specified for the same
// `role`.
@@ -643,7 +798,7 @@
// server.
googleapi.ServerResponse `json:"-"`
- // ForceSendFields is a list of field names (e.g. "Bindings") to
+ // ForceSendFields is a list of field names (e.g. "AuditConfigs") 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
@@ -651,10 +806,10 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Bindings") 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
+ // NullFields is a list of field names (e.g. "AuditConfigs") 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:"-"`
@@ -876,6 +1031,15 @@
// might reject them.
Policy *Policy `json:"policy,omitempty"`
+ // UpdateMask: OPTIONAL: A FieldMask specifying which fields of the
+ // policy to modify. Only
+ // the fields in the mask will be modified. If no mask is provided, a
+ // default
+ // mask is used:
+ // paths: "bindings, etag"
+ // This field is only used by Cloud IAM.
+ UpdateMask string `json:"updateMask,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "Policy") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json
index 0ef3b0c..798e7c4 100644
--- a/cloudtrace/v1/cloudtrace-api.json
+++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,4 +1,21 @@
{
+ "canonicalName": "Cloud Trace",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/trace.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"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://cloudtrace.googleapis.com/",
"ownerDomain": "google.com",
"name": "cloudtrace",
"batchPath": "batch",
@@ -8,8 +25,6 @@
"projects": {
"methods": {
"patchTraces": {
- "id": "cloudtrace.projects.patchTraces",
- "path": "v1/projects/{projectId}/traces",
"request": {
"$ref": "Traces"
},
@@ -23,53 +38,57 @@
},
"parameters": {
"projectId": {
- "location": "path",
"description": "ID of the Cloud project where the trace data is stored.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.append"
],
- "flatPath": "v1/projects/{projectId}/traces"
+ "flatPath": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.patchTraces",
+ "path": "v1/projects/{projectId}/traces"
}
},
"resources": {
"traces": {
"methods": {
"list": {
+ "flatPath": "v1/projects/{projectId}/traces",
+ "id": "cloudtrace.projects.traces.list",
+ "path": "v1/projects/{projectId}/traces",
+ "description": "Returns of a list of traces that match the specified filter conditions.",
+ "httpMethod": "GET",
"response": {
"$ref": "ListTracesResponse"
},
"parameterOrder": [
"projectId"
],
- "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
"parameters": {
- "projectId": {
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "location": "path"
- },
"filter": {
- "description": "An optional filter for the request.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "An optional filter for the request."
},
"endTime": {
+ "type": "string",
"location": "query",
"description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"startTime": {
+ "location": "query",
"description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
"format": "google-datetime",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
"location": "query",
@@ -77,13 +96,12 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"view": {
- "type": "string",
"location": "query",
"enum": [
"VIEW_TYPE_UNSPECIFIED",
@@ -91,22 +109,21 @@
"ROOTSPAN",
"COMPLETE"
],
- "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`."
+ "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.",
+ "type": "string"
},
"orderBy": {
+ "type": "string",
"location": "query",
- "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
- "type": "string"
+ "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted."
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored."
}
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "flatPath": "v1/projects/{projectId}/traces",
- "path": "v1/projects/{projectId}/traces",
- "id": "cloudtrace.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions."
+ }
},
"get": {
"response": {
@@ -117,24 +134,24 @@
"traceId"
],
"httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "traceId": {
+ "location": "path",
+ "description": "ID of the trace to return.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/trace.readonly"
],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string"
- },
- "traceId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "ID of the trace to return."
- }
- },
"flatPath": "v1/projects/{projectId}/traces/{traceId}",
"path": "v1/projects/{projectId}/traces/{traceId}",
"id": "cloudtrace.projects.traces.get",
@@ -146,27 +163,37 @@
}
},
"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": {
+ "description": "API key. Your API 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"
},
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
- "oauth_token": {
+ "quotaUser": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -178,15 +205,20 @@
"type": "boolean",
"default": "true"
},
- "fields": {
+ "uploadType": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "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.",
@@ -201,11 +233,6 @@
"2"
]
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -221,41 +248,37 @@
"proto"
],
"type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
}
},
"version": "v1",
"baseUrl": "https://cloudtrace.googleapis.com/",
+ "servicePath": "",
"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",
- "servicePath": "",
"basePath": "",
+ "revision": "20170225",
"id": "cloudtrace:v1",
"documentationLink": "https://cloud.google.com/trace",
- "revision": "20170225",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "TraceSpan": {
- "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
+ "Traces": {
+ "description": "List of new or updated traces.",
"type": "object",
"properties": {
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes.",
- "type": "object"
- },
+ "traces": {
+ "description": "List of traces.",
+ "type": "array",
+ "items": {
+ "$ref": "Trace"
+ }
+ }
+ },
+ "id": "Traces"
+ },
+ "TraceSpan": {
+ "type": "object",
+ "properties": {
"name": {
"type": "string",
"description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans."
@@ -276,12 +299,11 @@
"type": "string"
},
"startTime": {
+ "type": "string",
"description": "Start time of the span in nanoseconds from the UNIX epoch.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
},
"kind": {
- "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.",
"type": "string",
"enumDescriptions": [
"Unspecified.",
@@ -292,12 +314,22 @@
"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."
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes.",
+ "type": "object"
}
},
- "id": "TraceSpan"
+ "id": "TraceSpan",
+ "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace."
},
"ListTracesResponse": {
+ "description": "The response message for the `ListTraces` method.",
"type": "object",
"properties": {
"traces": {
@@ -312,8 +344,7 @@
"type": "string"
}
},
- "id": "ListTracesResponse",
- "description": "The response message for the `ListTraces` method."
+ "id": "ListTracesResponse"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
@@ -322,7 +353,6 @@
"id": "Empty"
},
"Trace": {
- "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.",
"type": "object",
"properties": {
"projectId": {
@@ -341,43 +371,13 @@
"type": "string"
}
},
- "id": "Trace"
- },
- "Traces": {
- "description": "List of new or updated traces.",
- "type": "object",
- "properties": {
- "traces": {
- "description": "List of traces.",
- "type": "array",
- "items": {
- "$ref": "Trace"
- }
- }
- },
- "id": "Traces"
+ "id": "Trace",
+ "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation."
}
},
- "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 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"
- }
- }
- }
- },
- "rootUrl": "https://cloudtrace.googleapis.com/"
+ "protocol": "rest"
}
diff --git a/content/v2/content-api.json b/content/v2/content-api.json
index 89441d4..a486f44 100644
--- a/content/v2/content-api.json
+++ b/content/v2/content-api.json
@@ -1,12 +1,12 @@
{
"kind": "discovery#restDescription",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/Q7x7O16Jjj1JyAS5e5qN_sA0jCo\"",
+ "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/ZCZOOwDCC1weteZqQodwch31zkc\"",
"discoveryVersion": "v1",
"id": "content:v2",
"name": "content",
"canonicalName": "Shopping Content",
"version": "v2",
- "revision": "20170207",
+ "revision": "20170303",
"title": "Content API for Shopping",
"description": "Manages product items, inventory, and Merchant Center accounts for Google Shopping.",
"ownerDomain": "google.com",
@@ -1215,7 +1215,7 @@
},
"contentType": {
"type": "string",
- "description": "The type of data feed.",
+ "description": "The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported.",
"annotations": {
"required": [
"content.datafeeds.insert",
diff --git a/content/v2/content-gen.go b/content/v2/content-gen.go
index 510ee5d..426efb4 100644
--- a/content/v2/content-gen.go
+++ b/content/v2/content-gen.go
@@ -1913,7 +1913,8 @@
// the feed. Must be a valid language for targetCountry.
ContentLanguage string `json:"contentLanguage,omitempty"`
- // ContentType: The type of data feed.
+ // ContentType: The type of data feed. For product inventory feeds, only
+ // feeds for local stores, not online stores, are supported.
ContentType string `json:"contentType,omitempty"`
// FetchSchedule: Fetch schedule for the feed file.
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json
index 468a686..c02a095 100644
--- a/dataflow/v1b3/dataflow-api.json
+++ b/dataflow/v1b3/dataflow-api.json
@@ -1,1026 +1,12 @@
{
- "documentationLink": "https://cloud.google.com/dataflow",
"revision": "20170303",
+ "documentationLink": "https://cloud.google.com/dataflow",
"id": "dataflow:v1b3",
"title": "Google Dataflow API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
"projects": {
- "resources": {
- "jobs": {
- "methods": {
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "description": "The level of information requested in response.",
- "type": "string",
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ]
- },
- "location": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/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."
- },
- "list": {
- "parameters": {
- "pageSize": {
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "type": "string",
- "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": {
- "location": "path",
- "description": "The project which owns the jobs.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "The kind of filter to use.",
- "type": "string",
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ]
- },
- "location": {
- "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/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.list",
- "description": "List the jobs of a project.",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job ID.",
- "required": true,
- "type": "string"
- },
- "location": {
- "location": "query",
- "description": "The location that contains this job.",
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}",
- "id": "dataflow.projects.jobs.update",
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "PUT"
- },
- "create": {
- "request": {
- "$ref": "Job"
- },
- "description": "Creates a Cloud Dataflow job.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string"
- },
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location that contains this job."
- },
- "replaceJobId": {
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs",
- "path": "v1b3/projects/{projectId}/jobs",
- "id": "dataflow.projects.jobs.create"
- },
- "getMetrics": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "type": "string",
- "location": "query",
- "description": "The location which contains the job specified by job_id."
- },
- "startTime": {
- "location": "query",
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "format": "google-datetime",
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "A project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job to get messages for."
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.jobs.getMetrics",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
- "description": "Request the job status.",
- "httpMethod": "GET",
- "response": {
- "$ref": "JobMetrics"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ]
- }
- },
- "resources": {
- "debug": {
- "methods": {
- "getConfig": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The project id."
- },
- "jobId": {
- "description": "The job id.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "id": "dataflow.projects.jobs.debug.getConfig",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
- "description": "Get encoded debug configuration for component. Not cacheable.",
- "request": {
- "$ref": "GetDebugConfigRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "response": {
- "$ref": "GetDebugConfigResponse"
- }
- },
- "sendCapture": {
- "request": {
- "$ref": "SendDebugCaptureRequest"
- },
- "description": "Send encoded debug capture data for component.",
- "response": {
- "$ref": "SendDebugCaptureResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job id.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
- "id": "dataflow.projects.jobs.debug.sendCapture"
- }
- }
- },
- "workItems": {
- "methods": {
- "reportStatus": {
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "description": "Reports the status of dataflow WorkItems leased by a worker.",
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project which owns the WorkItem's job.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The job which the WorkItem is part of."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "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"
- },
- "lease": {
- "description": "Leases a dataflow WorkItem to run.",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Identifies the project this worker belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "Identifies the workflow job this worker belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.jobs.workItems.lease"
- }
- }
- },
- "messages": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "jobId": {
- "description": "The job to get messages about.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "A project id."
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "type": "string",
- "location": "query"
- },
- "endTime": {
- "location": "query",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "location": "query",
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "format": "google-datetime",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "format": "int32",
- "type": "integer"
- },
- "minimumImportance": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
- "id": "dataflow.projects.jobs.messages.list",
- "description": "Request the job status."
- }
- }
- }
- }
- },
- "locations": {
- "resources": {
- "jobs": {
- "methods": {
- "getMetrics": {
- "response": {
- "$ref": "JobMetrics"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string"
- },
- "startTime": {
- "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "A project id.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job to get messages for.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
- "id": "dataflow.projects.locations.jobs.getMetrics",
- "description": "Request the job status."
- },
- "get": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "view": {
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string",
- "location": "query"
- }
- },
- "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."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListJobsResponse"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "description": "The project which owns the jobs.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "filter": {
- "location": "query",
- "enum": [
- "UNKNOWN",
- "ALL",
- "TERMINATED",
- "ACTIVE"
- ],
- "description": "The kind of filter to use.",
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
- "type": "string"
- }
- },
- "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."
- },
- "update": {
- "request": {
- "$ref": "Job"
- },
- "description": "Updates the state of an existing Cloud Dataflow job.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "location": {
- "location": "path",
- "description": "The location that contains this job.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
- "id": "dataflow.projects.locations.jobs.update",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}"
- },
- "create": {
- "description": "Creates a Cloud Dataflow job.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "location"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "location": {
- "description": "The location that contains this job.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "replaceJobId": {
- "description": "Deprecated. This field is now in the Job message.",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the Cloud Platform project that the job belongs to."
- },
- "view": {
- "location": "query",
- "enum": [
- "JOB_VIEW_UNKNOWN",
- "JOB_VIEW_SUMMARY",
- "JOB_VIEW_ALL",
- "JOB_VIEW_DESCRIPTION"
- ],
- "description": "The level of information requested in response.",
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs",
- "id": "dataflow.projects.locations.jobs.create"
- }
- },
- "resources": {
- "workItems": {
- "methods": {
- "lease": {
- "response": {
- "$ref": "LeaseWorkItemResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Identifies the project this worker belongs to."
- },
- "jobId": {
- "location": "path",
- "description": "Identifies the workflow job this worker belongs to.",
- "required": true,
- "type": "string"
- },
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
- "id": "dataflow.projects.locations.jobs.workItems.lease",
- "request": {
- "$ref": "LeaseWorkItemRequest"
- },
- "description": "Leases a dataflow WorkItem to run."
- },
- "reportStatus": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "response": {
- "$ref": "ReportWorkItemStatusResponse"
- },
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "The project which owns the WorkItem's job.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "location": "path",
- "description": "The job which the WorkItem is part of.",
- "required": true,
- "type": "string"
- },
- "location": {
- "location": "path",
- "description": "The location which contains the WorkItem's job.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "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",
- "request": {
- "$ref": "ReportWorkItemStatusRequest"
- },
- "description": "Reports the status of dataflow WorkItems leased by a worker."
- }
- }
- },
- "messages": {
- "methods": {
- "list": {
- "description": "Request the job status.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListJobMessagesResponse"
- },
- "parameterOrder": [
- "projectId",
- "location",
- "jobId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "A project id."
- },
- "jobId": {
- "description": "The job to get messages about.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "endTime": {
- "location": "query",
- "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
- "format": "google-datetime",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the job specified by job_id.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
- "type": "string"
- },
- "startTime": {
- "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
- "format": "int32",
- "type": "integer"
- },
- "minimumImportance": {
- "location": "query",
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "description": "Filter to only get messages with importance \u003e= level",
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
- "id": "dataflow.projects.locations.jobs.messages.list",
- "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages"
- }
- }
- }
- }
- }
- }
- },
- "templates": {
- "methods": {
- "launch": {
- "response": {
- "$ref": "LaunchTemplateResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "gcsPath": {
- "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.",
- "type": "string",
- "location": "query"
- },
- "dryRun": {
- "location": "query",
- "description": "Whether or not the job should actually be executed after\nvalidating parameters. Defaults to false. Validation errors do\nnot cause the HTTP request to fail if true.",
- "type": "boolean"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/templates:launch",
- "path": "v1b3/projects/{projectId}/templates:launch",
- "id": "dataflow.projects.templates.launch",
- "description": "Launch a template.",
- "request": {
- "$ref": "LaunchTemplateParameters"
- }
- },
- "get": {
- "description": "Get the template associated with a template.",
- "response": {
- "$ref": "GetTemplateResponse"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "view": {
- "location": "query",
- "enum": [
- "METADATA_ONLY"
- ],
- "description": "The view to retrieve. Defaults to METADATA_ONLY.",
- "type": "string"
- },
- "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"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/templates:get",
- "path": "v1b3/projects/{projectId}/templates:get",
- "id": "dataflow.projects.templates.get"
- },
- "create": {
- "description": "Creates a Cloud Dataflow job from a template.",
- "request": {
- "$ref": "CreateJobFromTemplateRequest"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/userinfo.email"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1b3/projects/{projectId}/templates",
- "path": "v1b3/projects/{projectId}/templates",
- "id": "dataflow.projects.templates.create"
- }
- }
- }
- },
"methods": {
"workerMessages": {
"flatPath": "v1b3/projects/{projectId}/WorkerMessages",
@@ -1039,10 +25,10 @@
},
"parameters": {
"projectId": {
+ "description": "The project to send the WorkerMessages to.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The project to send the WorkerMessages to."
+ "location": "path"
}
},
"scopes": [
@@ -1050,71 +36,1059 @@
"https://www.googleapis.com/auth/userinfo.email"
]
}
+ },
+ "resources": {
+ "locations": {
+ "resources": {
+ "jobs": {
+ "methods": {
+ "update": {
+ "description": "Updates the state of an existing Cloud Dataflow job.",
+ "request": {
+ "$ref": "Job"
+ },
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location that contains this job.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "id": "dataflow.projects.locations.jobs.update"
+ },
+ "create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response."
+ },
+ "location": {
+ "location": "path",
+ "description": "The location that contains this job.",
+ "required": true,
+ "type": "string"
+ },
+ "replaceJobId": {
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs",
+ "id": "dataflow.projects.locations.jobs.create",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs"
+ },
+ "getMetrics": {
+ "response": {
+ "$ref": "JobMetrics"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "startTime": {
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "location": "path",
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.locations.jobs.getMetrics",
+ "description": "Request the job status."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job ID."
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "id": "dataflow.projects.locations.jobs.get",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}",
+ "description": "Gets the state of the specified Cloud Dataflow job."
+ },
+ "list": {
+ "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.",
+ "parameterOrder": [
+ "projectId",
+ "location"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the jobs.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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",
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "resources": {
+ "workItems": {
+ "methods": {
+ "lease": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the WorkItem's job.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Identifies the project this worker belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifies the workflow job this worker belongs to."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "id": "dataflow.projects.locations.jobs.workItems.lease",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run."
+ },
+ "reportStatus": {
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "location": "path",
+ "description": "The location which contains the WorkItem's job.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The project which owns the WorkItem's job.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job which the WorkItem is part of.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus",
+ "id": "dataflow.projects.locations.jobs.workItems.reportStatus"
+ }
+ }
+ },
+ "messages": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListJobMessagesResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "location",
+ "jobId"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "A project id."
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job to get messages about."
+ },
+ "location": {
+ "description": "The location which contains the job specified by job_id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "endTime": {
+ "location": "query",
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "startTime": {
+ "location": "query",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "minimumImportance": {
+ "location": "query",
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Filter to only get messages with importance \u003e= level",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.locations.jobs.messages.list",
+ "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages",
+ "description": "Request the job status."
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "templates": {
+ "methods": {
+ "launch": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "LaunchTemplateResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "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"
+ },
+ "dryRun": {
+ "location": "query",
+ "description": "Whether or not the job should actually be executed after\nvalidating parameters. Defaults to false. Validation errors do\nnot cause the HTTP request to fail if true.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/templates:launch",
+ "id": "dataflow.projects.templates.launch",
+ "path": "v1b3/projects/{projectId}/templates:launch",
+ "description": "Launch a template.",
+ "request": {
+ "$ref": "LaunchTemplateParameters"
+ }
+ },
+ "get": {
+ "description": "Get the template associated with a template.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GetTemplateResponse"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "METADATA_ONLY"
+ ],
+ "description": "The view to retrieve. Defaults to METADATA_ONLY.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/templates:get",
+ "id": "dataflow.projects.templates.get",
+ "path": "v1b3/projects/{projectId}/templates:get"
+ },
+ "create": {
+ "request": {
+ "$ref": "CreateJobFromTemplateRequest"
+ },
+ "description": "Creates a Cloud Dataflow job from a template.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "Required. The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/templates",
+ "path": "v1b3/projects/{projectId}/templates",
+ "id": "dataflow.projects.templates.create"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "getMetrics": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "startTime": {
+ "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "A project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job to get messages for.",
+ "required": true,
+ "type": "string"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "id": "dataflow.projects.jobs.getMetrics",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics",
+ "description": "Request the job status.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "JobMetrics"
+ }
+ },
+ "get": {
+ "description": "Gets the state of the specified Cloud Dataflow job.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job ID."
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response.",
+ "type": "string"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}",
+ "id": "dataflow.projects.jobs.get",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}"
+ },
+ "list": {
+ "id": "dataflow.projects.jobs.list",
+ "path": "v1b3/projects/{projectId}/jobs",
+ "description": "List the jobs of a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListJobsResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "The project which owns the jobs.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "filter": {
+ "enum": [
+ "UNKNOWN",
+ "ALL",
+ "TERMINATED",
+ "ACTIVE"
+ ],
+ "description": "The kind of filter to use.",
+ "type": "string",
+ "location": "query"
+ },
+ "location": {
+ "location": "query",
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "view": {
+ "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ]
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs"
+ },
+ "update": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "type": "string",
+ "location": "query",
+ "description": "The location that contains this job."
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job ID.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "create": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a Cloud Dataflow job.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "Job"
+ },
+ "parameters": {
+ "replaceJobId": {
+ "location": "query",
+ "description": "Deprecated. This field is now in the Job message.",
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_VIEW_UNKNOWN",
+ "JOB_VIEW_SUMMARY",
+ "JOB_VIEW_ALL",
+ "JOB_VIEW_DESCRIPTION"
+ ],
+ "description": "The level of information requested in response."
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs",
+ "id": "dataflow.projects.jobs.create",
+ "path": "v1b3/projects/{projectId}/jobs"
+ }
+ },
+ "resources": {
+ "debug": {
+ "methods": {
+ "getConfig": {
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "id": "dataflow.projects.jobs.debug.getConfig",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig",
+ "description": "Get encoded debug configuration for component. Not cacheable.",
+ "request": {
+ "$ref": "GetDebugConfigRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "GetDebugConfigResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The job id."
+ }
+ }
+ },
+ "sendCapture": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "SendDebugCaptureResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "The project id.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "description": "The job id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "id": "dataflow.projects.jobs.debug.sendCapture",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture",
+ "description": "Send encoded debug capture data for component.",
+ "request": {
+ "$ref": "SendDebugCaptureRequest"
+ }
+ }
+ }
+ },
+ "workItems": {
+ "methods": {
+ "reportStatus": {
+ "id": "dataflow.projects.jobs.workItems.reportStatus",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus",
+ "description": "Reports the status of dataflow WorkItems leased by a worker.",
+ "request": {
+ "$ref": "ReportWorkItemStatusRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "ReportWorkItemStatusResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "The project which owns the WorkItem's job.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The job which the WorkItem is part of.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus"
+ },
+ "lease": {
+ "id": "dataflow.projects.jobs.workItems.lease",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease",
+ "request": {
+ "$ref": "LeaseWorkItemRequest"
+ },
+ "description": "Leases a dataflow WorkItem to run.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "LeaseWorkItemResponse"
+ },
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Identifies the project this worker belongs to."
+ },
+ "jobId": {
+ "description": "Identifies the workflow job this worker belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease"
+ }
+ }
+ },
+ "messages": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "jobId"
+ ],
+ "response": {
+ "$ref": "ListJobMessagesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/userinfo.email"
+ ],
+ "parameters": {
+ "location": {
+ "location": "query",
+ "description": "The location which contains the job specified by job_id.",
+ "type": "string"
+ },
+ "endTime": {
+ "location": "query",
+ "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.",
+ "type": "string"
+ },
+ "startTime": {
+ "location": "query",
+ "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "minimumImportance": {
+ "description": "Filter to only get messages with importance \u003e= level",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ]
+ },
+ "projectId": {
+ "description": "A project id.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "jobId": {
+ "description": "The job to get messages about.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "id": "dataflow.projects.jobs.messages.list",
+ "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages",
+ "description": "Request the job status."
+ }
+ }
+ }
+ }
+ }
}
}
},
"parameters": {
- "quotaUser": {
+ "uploadType": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
"fields": {
"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"
+ },
+ "callback": {
"type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ]
+ "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",
@@ -1122,39 +1096,2248 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
+ "default": "json"
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "key": {
+ "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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
- "IntegerList": {
- "description": "A metric value representing a list of integers.",
+ "RuntimeEnvironment": {
+ "properties": {
+ "maxWorkers": {
+ "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "zone": {
+ "description": "The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "RuntimeEnvironment",
+ "description": "The environment values to set at runtime.",
+ "type": "object"
+ },
+ "StreamingSideInputLocation": {
+ "type": "object",
+ "properties": {
+ "stateFamily": {
+ "description": "Identifies the state family where this side input is stored.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Identifies the particular side input within the streaming Dataflow job.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingSideInputLocation",
+ "description": "Identifies the location of a streaming side input."
+ },
+ "MountedDataDisk": {
+ "properties": {
+ "dataDisk": {
+ "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
+ "type": "string"
+ }
+ },
+ "id": "MountedDataDisk",
+ "description": "Describes mounted data disk.",
+ "type": "object"
+ },
+ "LaunchTemplateResponse": {
+ "description": "Response to the request to launch a template.",
+ "type": "object",
+ "properties": {
+ "job": {
+ "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched.",
+ "$ref": "Job"
+ },
+ "status": {
+ "description": "The status of the launch template request. Any problems with the request\nwill be indicated in the error_details.",
+ "$ref": "Status"
+ }
+ },
+ "id": "LaunchTemplateResponse"
+ },
+ "Job": {
+ "properties": {
+ "replacedByJobId": {
+ "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
+ "type": "string"
+ },
+ "steps": {
+ "description": "The top-level steps that constitute the entire job.",
+ "type": "array",
+ "items": {
+ "$ref": "Step"
+ }
+ },
+ "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`."
+ ],
+ "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"
+ ]
+ },
+ "location": {
+ "description": "The location that contains this job.",
+ "type": "string"
+ },
+ "currentStateTime": {
+ "description": "The timestamp associated with the current state.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "transformNameMapping": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
+ "type": "object"
+ },
+ "environment": {
+ "description": "The environment for the job.",
+ "$ref": "Environment"
+ },
+ "createTime": {
+ "type": "string",
+ "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
+ "format": "google-datetime"
+ },
+ "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"
+ },
+ "projectId": {
+ "description": "The ID of the Cloud Platform project that the job belongs to.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "The type of the job is unspecified, or unknown.",
+ "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
+ "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
+ ],
+ "enum": [
+ "JOB_TYPE_UNKNOWN",
+ "JOB_TYPE_BATCH",
+ "JOB_TYPE_STREAMING"
+ ],
+ "description": "The type of Cloud Dataflow job.",
+ "type": "string"
+ },
+ "pipelineDescription": {
+ "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.",
+ "$ref": "PipelineDescription"
+ },
+ "replaceJobId": {
+ "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.",
+ "type": "string"
+ },
+ "requestedState": {
+ "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`."
+ ],
+ "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"
+ ],
+ "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}",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "clientRequestId": {
+ "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
+ "type": "string"
+ },
+ "name": {
+ "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])?`"
+ }
+ },
+ "id": "Job",
+ "description": "Defines a job to be run by the Cloud Dataflow service.",
+ "type": "object"
+ },
+ "DynamicSourceSplit": {
+ "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.",
+ "type": "object",
+ "properties": {
+ "residual": {
+ "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source.",
+ "$ref": "DerivedSource"
+ },
+ "primary": {
+ "$ref": "DerivedSource",
+ "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current."
+ }
+ },
+ "id": "DynamicSourceSplit"
+ },
+ "DerivedSource": {
+ "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
+ "type": "object",
+ "properties": {
+ "derivationMode": {
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "What source to base the produced source on (if any).",
+ "type": "string"
+ },
+ "source": {
+ "description": "Specification of the source.",
+ "$ref": "Source"
+ }
+ },
+ "id": "DerivedSource"
+ },
+ "SourceOperationResponse": {
+ "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
+ "type": "object",
+ "properties": {
+ "split": {
+ "$ref": "SourceSplitResponse",
+ "description": "A response to a request to split a source."
+ },
+ "getMetadata": {
+ "description": "A response to a request to get metadata about a source.",
+ "$ref": "SourceGetMetadataResponse"
+ }
+ },
+ "id": "SourceOperationResponse"
+ },
+ "SideInputInfo": {
+ "id": "SideInputInfo",
+ "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
+ "type": "object",
+ "properties": {
+ "sources": {
+ "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.",
+ "type": "array",
+ "items": {
+ "$ref": "Source"
+ }
+ },
+ "kind": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "How to interpret the source element(s) as a side input value."
+ },
+ "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"
+ }
+ }
+ },
+ "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": {
+ "$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": {
+ "description": "Index of the inner source.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ConcatPosition"
+ },
+ "CounterStructuredNameAndMetadata": {
+ "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "CounterMetadata",
+ "description": "Metadata associated with a counter"
+ },
+ "name": {
+ "$ref": "CounterStructuredName",
+ "description": "Structured name of the counter."
+ }
+ },
+ "id": "CounterStructuredNameAndMetadata"
+ },
+ "AutoscalingSettings": {
+ "description": "Settings for WorkerPool autoscaling.",
+ "type": "object",
+ "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": {
+ "description": "The maximum number of workers to cap scaling at.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AutoscalingSettings"
+ },
+ "StreamingComputationRanges": {
+ "description": "Describes full or partial data disk assignment information of the computation\nranges.",
+ "type": "object",
+ "properties": {
+ "computationId": {
+ "description": "The ID of the computation.",
+ "type": "string"
+ },
+ "rangeAssignments": {
+ "type": "array",
+ "items": {
+ "$ref": "KeyRangeDataDiskAssignment"
+ },
+ "description": "Data disk assignments for ranges from this computation."
+ }
+ },
+ "id": "StreamingComputationRanges"
+ },
+ "ExecutionStageSummary": {
+ "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.",
+ "type": "object",
+ "properties": {
+ "outputSource": {
+ "type": "array",
+ "items": {
+ "$ref": "StageSource"
+ },
+ "description": "Output sources for this stage."
+ },
+ "name": {
+ "description": "Dataflow service generated name for this stage.",
+ "type": "string"
+ },
+ "inputSource": {
+ "description": "Input sources for this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "StageSource"
+ }
+ },
+ "id": {
+ "type": "string",
+ "description": "Dataflow service generated id for this stage."
+ },
+ "componentTransform": {
+ "type": "array",
+ "items": {
+ "$ref": "ComponentTransform"
+ },
+ "description": "Transforms that comprise this execution stage."
+ },
+ "componentSource": {
+ "description": "Collections produced and consumed by component transforms of this stage.",
+ "type": "array",
+ "items": {
+ "$ref": "ComponentSource"
+ }
+ },
+ "kind": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unrecognized transform type.",
+ "ParDo transform.",
+ "Group By Key transform.",
+ "Flatten transform.",
+ "Read transform.",
+ "Write transform.",
+ "Constructs from a constant value, such as with Create.of.",
+ "Creates a Singleton view of a collection.",
+ "Opening or closing a shuffle session, often as part of a GroupByKey."
+ ],
+ "enum": [
+ "UNKNOWN_KIND",
+ "PAR_DO_KIND",
+ "GROUP_BY_KEY_KIND",
+ "FLATTEN_KIND",
+ "READ_KIND",
+ "WRITE_KIND",
+ "CONSTANT_KIND",
+ "SINGLETON_KIND",
+ "SHUFFLE_KIND"
+ ],
+ "description": "Type of tranform this stage is executing."
+ }
+ },
+ "id": "ExecutionStageSummary"
+ },
+ "SendWorkerMessagesRequest": {
+ "description": "A request for sending worker messages to the service.",
+ "type": "object",
+ "properties": {
+ "workerMessages": {
+ "description": "The WorkerMessages to send.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkerMessage"
+ }
+ }
+ },
+ "id": "SendWorkerMessagesRequest"
+ },
+ "SourceSplitShard": {
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "DEPRECATED"
+ },
+ "derivationMode": {
+ "enumDescriptions": [
+ "The source derivation is unknown, or unspecified.",
+ "Produce a completely independent Source with no base.",
+ "Produce a Source based on the Source being split.",
+ "Produce a Source based on the base of the Source being split."
+ ],
+ "enum": [
+ "SOURCE_DERIVATION_MODE_UNKNOWN",
+ "SOURCE_DERIVATION_MODE_INDEPENDENT",
+ "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
+ "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
+ ],
+ "description": "DEPRECATED",
+ "type": "string"
+ }
+ },
+ "id": "SourceSplitShard",
+ "description": "DEPRECATED in favor of DerivedSource.",
+ "type": "object"
+ },
+ "CPUTime": {
+ "id": "CPUTime",
+ "description": "Modeled after information exposed by /proc/stat.",
+ "type": "object",
+ "properties": {
+ "rate": {
+ "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
+ "format": "double",
+ "type": "number"
+ },
+ "timestamp": {
+ "description": "Timestamp of the measurement.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "totalMs": {
+ "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
+ "format": "uint64",
+ "type": "string"
+ }
+ }
+ },
+ "Environment": {
+ "description": "Describes the environment in which a Dataflow Job runs.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "workerPools": {
+ "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkerPool"
+ }
+ },
+ "dataset": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "internalExperiments": {
+ "description": "Experimental settings.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ },
+ "version": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
+ "type": "object"
+ },
+ "serviceAccountEmail": {
+ "description": "Identity to run virtual machines as. Defaults to the default account.",
+ "type": "string"
+ },
+ "userAgent": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "A description of the process that generated the request.",
+ "type": "object"
+ },
+ "sdkPipelineOptions": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way.",
+ "type": "object"
+ }
+ },
+ "id": "Environment"
+ },
+ "StreamingComputationTask": {
+ "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
+ "type": "object",
+ "properties": {
+ "taskType": {
+ "enumDescriptions": [
+ "The streaming computation task is unknown, or unspecified.",
+ "Stop processing specified streaming computation range(s).",
+ "Start processing specified streaming computation range(s)."
+ ],
+ "enum": [
+ "STREAMING_COMPUTATION_TASK_UNKNOWN",
+ "STREAMING_COMPUTATION_TASK_STOP",
+ "STREAMING_COMPUTATION_TASK_START"
+ ],
+ "description": "A type of streaming computation task.",
+ "type": "string"
+ },
+ "computationRanges": {
+ "description": "Contains ranges of a streaming computation this task should apply to.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationRanges"
+ }
+ },
+ "dataDisks": {
+ "description": "Describes the set of data disks this task should apply to.",
+ "type": "array",
+ "items": {
+ "$ref": "MountedDataDisk"
+ }
+ }
+ },
+ "id": "StreamingComputationTask"
+ },
+ "SendDebugCaptureRequest": {
+ "id": "SendDebugCaptureRequest",
+ "description": "Request to send encoded debug information.",
+ "type": "object",
+ "properties": {
+ "componentId": {
+ "description": "The internal component id for which debug information is sent.",
+ "type": "string"
+ },
+ "workerId": {
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
+ },
+ "data": {
+ "type": "string",
+ "description": "The encoded debug information."
+ }
+ }
+ },
+ "GetDebugConfigResponse": {
+ "description": "Response to a get debug configuration request.",
+ "type": "object",
+ "properties": {
+ "config": {
+ "type": "string",
+ "description": "The encoded debug configuration for the requested component."
+ }
+ },
+ "id": "GetDebugConfigResponse"
+ },
+ "ComponentTransform": {
+ "description": "Description of a transform executed as part of an execution stage.",
+ "type": "object",
+ "properties": {
+ "originalTransform": {
+ "description": "User name for the original user transform with which this transform is\nmost closely associated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Dataflow service generated name for this source.",
+ "type": "string"
+ },
+ "userName": {
+ "type": "string",
+ "description": "Human-readable name for this transform; may be user or system generated."
+ }
+ },
+ "id": "ComponentTransform"
+ },
+ "StreamingSetupTask": {
+ "properties": {
+ "workerHarnessPort": {
+ "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "drain": {
+ "description": "The user has requested drain.",
+ "type": "boolean"
+ },
+ "receiveWorkPort": {
+ "type": "integer",
+ "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
+ "format": "int32"
+ },
+ "streamingComputationTopology": {
+ "description": "The global topology of the streaming Dataflow job.",
+ "$ref": "TopologyConfig"
+ }
+ },
+ "id": "StreamingSetupTask",
+ "description": "A task which initializes part of a streaming Dataflow job.",
+ "type": "object"
+ },
+ "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": {
+ "type": "string",
+ "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\""
+ },
+ "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": {
+ "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": {
+ "id": "WorkerHealthReport",
+ "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
+ "type": "object",
+ "properties": {
+ "vmIsHealthy": {
+ "description": "Whether the VM is healthy.",
+ "type": "boolean"
+ },
+ "reportInterval": {
+ "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "pods": {
+ "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "vmStartupTime": {
+ "description": "The time the VM was booted.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ }
+ },
+ "JobMessage": {
+ "description": "A particular message pertaining to a Dataflow job.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Identifies the message. This is automatically generated by the\nservice; the caller should treat it as an opaque string.",
+ "type": "string"
+ },
+ "messageText": {
+ "description": "The text of the message.",
+ "type": "string"
+ },
+ "messageImportance": {
+ "enum": [
+ "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
+ "JOB_MESSAGE_DEBUG",
+ "JOB_MESSAGE_DETAILED",
+ "JOB_MESSAGE_BASIC",
+ "JOB_MESSAGE_WARNING",
+ "JOB_MESSAGE_ERROR"
+ ],
+ "description": "Importance level of the message.",
+ "type": "string",
+ "enumDescriptions": [
+ "The message importance isn't specified, or is unknown.",
+ "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
+ "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
+ "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
+ "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
+ "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
+ ]
+ },
+ "time": {
+ "description": "The timestamp of the message.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "JobMessage"
+ },
+ "ParameterMetadata": {
+ "properties": {
+ "isOptional": {
+ "type": "boolean",
+ "description": "Optional. Whether the parameter is optional. Defaults to false."
+ },
+ "name": {
+ "description": "Required. The name of the parameter.",
+ "type": "string"
+ },
+ "regexes": {
+ "description": "Optional. Regexes that the parameter must match.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "label": {
+ "description": "Required. The label to display for the parameter.",
+ "type": "string"
+ },
+ "helpText": {
+ "description": "Required. The help text to display for the parameter.",
+ "type": "string"
+ }
+ },
+ "id": "ParameterMetadata",
+ "description": "Metadata for a specific parameter.",
+ "type": "object"
+ },
+ "MultiOutputInfo": {
+ "properties": {
+ "tag": {
+ "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
+ "type": "string"
+ }
+ },
+ "id": "MultiOutputInfo",
+ "description": "Information about an output of a multi-output DoFn.",
+ "type": "object"
+ },
+ "SourceSplitRequest": {
+ "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "$ref": "Source",
+ "description": "Specification of the source to be split."
+ },
+ "options": {
+ "$ref": "SourceSplitOptions",
+ "description": "Hints for tuning the splitting process."
+ }
+ },
+ "id": "SourceSplitRequest"
+ },
+ "SourceGetMetadataResponse": {
+ "description": "The result of a SourceGetMetadataOperation.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "SourceMetadata",
+ "description": "The computed metadata."
+ }
+ },
+ "id": "SourceGetMetadataResponse"
+ },
+ "ShellTask": {
+ "properties": {
+ "exitCode": {
+ "description": "Exit code for the task.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "command": {
+ "description": "The shell command to run.",
+ "type": "string"
+ }
+ },
+ "id": "ShellTask",
+ "description": "A task which consists of a shell command for the worker to execute.",
+ "type": "object"
+ },
+ "MetricShortId": {
+ "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
+ "type": "object",
+ "properties": {
+ "metricIndex": {
+ "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "shortId": {
+ "description": "The service-generated short identifier for the metric.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "MetricShortId"
+ },
+ "TaskRunnerSettings": {
+ "description": "Taskrunner configuration settings.",
+ "type": "object",
+ "properties": {
+ "baseUrl": {
+ "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
+ "type": "string"
+ },
+ "logToSerialconsole": {
+ "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
+ "type": "boolean"
+ },
+ "continueOnException": {
+ "description": "Whether to continue taskrunner if an exception is hit.",
+ "type": "boolean"
+ },
+ "parallelWorkerSettings": {
+ "$ref": "WorkerSettings",
+ "description": "The settings to pass to the parallel worker harness."
+ },
+ "vmId": {
+ "type": "string",
+ "description": "The ID string of the VM."
+ },
+ "taskUser": {
+ "type": "string",
+ "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"."
+ },
+ "alsologtostderr": {
+ "type": "boolean",
+ "description": "Whether to also send taskrunner log info to stderr."
+ },
+ "taskGroup": {
+ "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
+ "type": "string"
+ },
+ "harnessCommand": {
+ "description": "The command to launch the worker harness.",
+ "type": "string"
+ },
+ "logDir": {
+ "description": "The directory on the VM to store logs.",
+ "type": "string"
+ },
+ "oauthScopes": {
+ "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "dataflowApiVersion": {
+ "description": "The API version of endpoint, e.g. \"v1b3\"",
+ "type": "string"
+ },
+ "logUploadLocation": {
+ "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "streamingWorkerMainClass": {
+ "description": "The streaming worker main class name.",
+ "type": "string"
+ },
+ "workflowFileName": {
+ "description": "The file to store the workflow in.",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ },
+ "baseTaskDir": {
+ "description": "The location on the worker for task-specific subdirectories.",
+ "type": "string"
+ },
+ "languageHint": {
+ "description": "The suggested backend language.",
+ "type": "string"
+ },
+ "commandlinesFileName": {
+ "description": "The file to store preprocessing commands in.",
+ "type": "string"
+ }
+ },
+ "id": "TaskRunnerSettings"
+ },
+ "Position": {
+ "id": "Position",
+ "description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index.",
+ "type": "object",
+ "properties": {
+ "shufflePosition": {
+ "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
+ "type": "string"
+ },
+ "concatPosition": {
+ "$ref": "ConcatPosition",
+ "description": "CloudPosition is a concat position."
+ },
+ "byteOffset": {
+ "description": "Position is a byte offset.",
+ "format": "int64",
+ "type": "string"
+ },
+ "end": {
+ "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.",
+ "type": "boolean"
+ },
+ "key": {
+ "description": "Position is a string key, ordered lexicographically.",
+ "type": "string"
+ },
+ "recordIndex": {
+ "description": "Position is a record index.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "SplitInt64": {
+ "type": "object",
+ "properties": {
+ "lowBits": {
+ "description": "The low order bits: n & 0xffffffff.",
+ "format": "uint32",
+ "type": "integer"
+ },
+ "highBits": {
+ "description": "The high order bits, including the sign: n \u003e\u003e 32.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "SplitInt64",
+ "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON."
+ },
+ "Source": {
+ "id": "Source",
+ "description": "A source that records can be read and decoded from.",
+ "type": "object",
+ "properties": {
+ "codec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to decode data read from the source.",
+ "type": "object"
+ },
+ "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."
+ },
+ "spec": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The source to read from, plus its parameters."
+ },
+ "metadata": {
+ "$ref": "SourceMetadata",
+ "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated."
+ },
+ "baseSpecs": {
+ "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ }
+ }
+ }
+ }
+ },
+ "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": {
+ "subnetwork": {
+ "type": "string",
+ "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\"."
+ },
+ "ipConfiguration": {
+ "type": "string",
+ "enumDescriptions": [
+ "The configuration is unknown, or unspecified.",
+ "Workers should have public IP addresses.",
+ "Workers should have private IP addresses."
+ ],
+ "enum": [
+ "WORKER_IP_UNSPECIFIED",
+ "WORKER_IP_PUBLIC",
+ "WORKER_IP_PRIVATE"
+ ],
+ "description": "Configuration for VM IPs."
+ },
+ "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": {
+ "$ref": "AutoscalingSettings",
+ "description": "Settings for autoscaling of this WorkerPool."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata to set on the Google Compute Engine VMs.",
+ "type": "object"
+ },
+ "defaultPackageSet": {
+ "type": "string",
+ "enumDescriptions": [
+ "The default set of packages to stage is unknown, or unspecified.",
+ "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
+ "Stage packages typically useful to workers written in Java.",
+ "Stage pacakges typically useful to workers written in Python."
+ ],
+ "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."
+ },
+ "network": {
+ "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".",
+ "type": "string"
+ },
+ "numThreadsPerWorker": {
+ "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "numWorkers": {
+ "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "zone": {
+ "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "diskSourceImage": {
+ "description": "Fully qualified source image for disks.",
+ "type": "string"
+ },
+ "packages": {
+ "type": "array",
+ "items": {
+ "$ref": "Package"
+ },
+ "description": "Packages to be installed on workers."
+ },
+ "teardownPolicy": {
+ "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.",
+ "type": "string",
+ "enumDescriptions": [
+ "The teardown policy isn't specified, or is unknown.",
+ "Always teardown the resource.",
+ "Teardown the resource on success. This is useful for debugging\nfailures.",
+ "Never teardown the resource. This is useful for debugging and\ndevelopment."
+ ],
+ "enum": [
+ "TEARDOWN_POLICY_UNKNOWN",
+ "TEARDOWN_ALWAYS",
+ "TEARDOWN_ON_SUCCESS",
+ "TEARDOWN_NEVER"
+ ]
+ },
+ "onHostMaintenance": {
+ "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
+ "type": "string"
+ },
+ "poolArgs": {
+ "description": "Extra arguments for this worker pool.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ },
+ "diskSizeGb": {
+ "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "workerHarnessContainerImage": {
+ "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
+ "type": "string"
+ },
+ "machineType": {
+ "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "diskType": {
+ "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
+ "type": "string"
+ },
+ "dataDisks": {
+ "type": "array",
+ "items": {
+ "$ref": "Disk"
+ },
+ "description": "Data disks that are used by a VM in this workflow."
+ }
+ },
+ "id": "WorkerPool"
+ },
+ "SourceOperationRequest": {
+ "type": "object",
+ "properties": {
+ "split": {
+ "description": "Information about a request to split a source.",
+ "$ref": "SourceSplitRequest"
+ },
+ "getMetadata": {
+ "$ref": "SourceGetMetadataRequest",
+ "description": "Information about a request to get metadata about a source."
+ }
+ },
+ "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": {
+ "id": {
+ "type": "string",
+ "description": "Identifies this WorkItem.",
+ "format": "int64"
+ },
+ "configuration": {
+ "type": "string",
+ "description": "Work item-specific configuration as an opaque blob."
+ },
+ "mapTask": {
+ "$ref": "MapTask",
+ "description": "Additional information for MapTask WorkItems."
+ },
+ "seqMapTask": {
+ "$ref": "SeqMapTask",
+ "description": "Additional information for SeqMapTask WorkItems."
+ },
+ "packages": {
+ "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.",
+ "type": "array",
+ "items": {
+ "$ref": "Package"
+ }
+ },
+ "projectId": {
+ "description": "Identifies the cloud project this WorkItem belongs to.",
+ "type": "string"
+ },
+ "sourceOperationTask": {
+ "$ref": "SourceOperationRequest",
+ "description": "Additional information for source operation WorkItems."
+ },
+ "reportStatusInterval": {
+ "description": "Recommended reporting interval.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "streamingSetupTask": {
+ "$ref": "StreamingSetupTask",
+ "description": "Additional information for StreamingSetupTask WorkItems."
+ },
+ "streamingConfigTask": {
+ "$ref": "StreamingConfigTask",
+ "description": "Additional information for StreamingConfigTask WorkItems."
+ },
+ "leaseExpireTime": {
+ "type": "string",
+ "description": "Time when the lease on this Work will expire.",
+ "format": "google-datetime"
+ },
+ "initialReportIndex": {
+ "type": "string",
+ "description": "The initial index to use when reporting the status of the WorkItem.",
+ "format": "int64"
+ },
+ "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": "WorkItem"
+ },
+ "ResourceUtilizationReport": {
+ "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",
+ "properties": {
+ "cpuTime": {
+ "description": "CPU utilization samples.",
+ "type": "array",
+ "items": {
+ "$ref": "CPUTime"
+ }
+ }
+ }
+ },
+ "ReportedParallelism": {
+ "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
+ "type": "object",
+ "properties": {
+ "isInfinite": {
+ "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "Specifies the level of parallelism in case it is finite.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "ReportedParallelism"
+ },
+ "TopologyConfig": {
+ "id": "TopologyConfig",
+ "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
+ "type": "object",
+ "properties": {
+ "userStageToComputationNameMap": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Maps user stage names to stable computation names.",
+ "type": "object"
+ },
+ "computations": {
+ "description": "The computations associated with a streaming Dataflow job.",
+ "type": "array",
+ "items": {
+ "$ref": "ComputationTopology"
+ }
+ },
+ "dataDiskAssignments": {
+ "type": "array",
+ "items": {
+ "$ref": "DataDiskAssignment"
+ },
+ "description": "The disks assigned to a streaming Dataflow job."
+ },
+ "persistentStateVersion": {
+ "description": "Version number for persistent state.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "forwardingKeyBits": {
+ "type": "integer",
+ "description": "The size (in bits) of keys that will be assigned to source messages.",
+ "format": "int32"
+ }
+ }
+ },
+ "SourceSplitOptions": {
+ "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.",
+ "type": "object",
+ "properties": {
+ "desiredBundleSizeBytes": {
+ "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
+ "format": "int64",
+ "type": "string"
+ },
+ "desiredShardSizeBytes": {
+ "type": "string",
+ "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
+ "format": "int64"
+ }
+ },
+ "id": "SourceSplitOptions"
+ },
+ "ReadInstruction": {
+ "description": "An instruction that reads records.\nTakes no inputs, produces one output.",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "The source to read from.",
+ "$ref": "Source"
+ }
+ },
+ "id": "ReadInstruction"
+ },
+ "WorkerSettings": {
+ "properties": {
+ "reportingEnabled": {
+ "description": "Whether to send work progress updates to the service.",
+ "type": "boolean"
+ },
+ "baseUrl": {
+ "type": "string",
+ "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/\""
+ },
+ "servicePath": {
+ "type": "string",
+ "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\"."
+ },
+ "shuffleServicePath": {
+ "type": "string",
+ "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\"."
+ },
+ "workerId": {
+ "description": "The ID of the worker running this pipeline.",
+ "type": "string"
+ },
+ "tempStoragePrefix": {
+ "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
+ "type": "string"
+ }
+ },
+ "id": "WorkerSettings",
+ "description": "Provides data to pass through to the worker harness.",
+ "type": "object"
+ },
+ "DataDiskAssignment": {
+ "properties": {
+ "vmInstance": {
+ "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
+ "type": "string"
+ },
+ "dataDisks": {
+ "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "DataDiskAssignment",
+ "description": "Data disk assignment for a given VM instance.",
+ "type": "object"
+ },
+ "StreamingStageLocation": {
+ "type": "object",
+ "properties": {
+ "streamId": {
+ "description": "Identifies the particular stream within the streaming Dataflow\njob.",
+ "type": "string"
+ }
+ },
+ "id": "StreamingStageLocation",
+ "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication."
+ },
+ "ApproximateSplitRequest": {
+ "id": "ApproximateSplitRequest",
+ "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
+ "type": "object",
+ "properties": {
+ "fractionConsumed": {
+ "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
+ "format": "double",
+ "type": "number"
+ },
+ "position": {
+ "description": "A Position at which to split the work item.",
+ "$ref": "Position"
+ }
+ }
+ },
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "StreamLocation": {
+ "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
+ "type": "object",
+ "properties": {
+ "customSourceLocation": {
+ "$ref": "CustomSourceLocation",
+ "description": "The stream is a custom source."
+ },
+ "streamingStageLocation": {
+ "description": "The stream is part of another computation within the current\nstreaming Dataflow job.",
+ "$ref": "StreamingStageLocation"
+ },
+ "pubsubLocation": {
+ "$ref": "PubsubLocation",
+ "description": "The stream is a pubsub stream."
+ },
+ "sideInputLocation": {
+ "$ref": "StreamingSideInputLocation",
+ "description": "The stream is a streaming side input."
+ }
+ },
+ "id": "StreamLocation"
+ },
+ "SendWorkerMessagesResponse": {
+ "description": "The response to the worker messages.",
+ "type": "object",
+ "properties": {
+ "workerMessageResponses": {
+ "description": "The servers response to the worker messages.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkerMessageResponse"
+ }
+ }
+ },
+ "id": "SendWorkerMessagesResponse"
+ },
+ "TransformSummary": {
+ "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"
+ },
+ "outputCollectionName": {
+ "description": "User names for all collection outputs to this transform.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "displayData": {
+ "description": "Transform-specific display data.",
+ "type": "array",
+ "items": {
+ "$ref": "DisplayData"
+ }
+ },
+ "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 transform.",
+ "type": "string"
+ },
+ "inputCollectionName": {
+ "description": "User names for all collection inputs to this transform.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TransformSummary",
+ "description": "Description of the type, names/ids, and input/outputs for a transform."
+ },
+ "StreamingComputationConfig": {
+ "description": "Configuration information for a single streaming computation.",
+ "type": "object",
+ "properties": {
+ "computationId": {
+ "description": "Unique identifier for this computation.",
+ "type": "string"
+ },
+ "systemName": {
+ "description": "System defined name for this computation.",
+ "type": "string"
+ },
+ "stageName": {
+ "type": "string",
+ "description": "Stage name of this computation."
+ },
+ "instructions": {
+ "type": "array",
+ "items": {
+ "$ref": "ParallelInstruction"
+ },
+ "description": "Instructions that comprise the computation."
+ }
+ },
+ "id": "StreamingComputationConfig"
+ },
+ "LeaseWorkItemResponse": {
+ "description": "Response to a request to lease WorkItems.",
+ "type": "object",
+ "properties": {
+ "workItems": {
+ "description": "A list of the leased WorkItems.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkItem"
+ }
+ }
+ },
+ "id": "LeaseWorkItemResponse"
+ },
+ "LaunchTemplateParameters": {
+ "id": "LaunchTemplateParameters",
+ "description": "Parameters to provide to the template being launched.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "environment": {
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
+ }
+ }
+ },
+ "Sink": {
+ "description": "A sink that records can be encoded and written to.",
+ "type": "object",
+ "properties": {
+ "spec": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The sink to write to, plus its parameters.",
+ "type": "object"
+ },
+ "codec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use to encode data written to the sink.",
+ "type": "object"
+ }
+ },
+ "id": "Sink"
+ },
+ "FlattenInstruction": {
+ "description": "An instruction that copies its inputs (zero or more) to its (single) output.",
+ "type": "object",
+ "properties": {
+ "inputs": {
+ "type": "array",
+ "items": {
+ "$ref": "InstructionInput"
+ },
+ "description": "Describes the inputs to the flatten instruction."
+ }
+ },
+ "id": "FlattenInstruction"
+ },
+ "PartialGroupByKeyInstruction": {
+ "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
+ "type": "object",
+ "properties": {
+ "originalCombineValuesStepName": {
+ "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
+ "type": "string"
+ },
+ "sideInputs": {
+ "description": "Zero or more side inputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SideInputInfo"
+ }
+ },
+ "input": {
+ "$ref": "InstructionInput",
+ "description": "Describes the input to the partial group-by-key instruction."
+ },
+ "inputElementCodec": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The codec to use for interpreting an element in the input PTable.",
+ "type": "object"
+ },
+ "valueCombiningFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The value combining function to invoke.",
+ "type": "object"
+ },
+ "originalCombineValuesInputStoreName": {
+ "type": "string",
+ "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues."
+ }
+ },
+ "id": "PartialGroupByKeyInstruction"
+ },
+ "InstructionInput": {
+ "id": "InstructionInput",
+ "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
+ "type": "object",
+ "properties": {
+ "outputNum": {
+ "type": "integer",
+ "description": "The output index (origin zero) within the producer.",
+ "format": "int32"
+ },
+ "producerInstructionIndex": {
+ "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "StageSource": {
+ "description": "Description of an input or output of an execution stage.",
+ "type": "object",
+ "properties": {
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Dataflow service generated name for this source.",
+ "type": "string"
+ },
+ "sizeBytes": {
+ "description": "Size of the source, if measurable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "userName": {
+ "description": "Human-readable name for this source; may be user or system generated.",
+ "type": "string"
+ }
+ },
+ "id": "StageSource"
+ },
+ "StringList": {
"type": "object",
"properties": {
"elements": {
"description": "Elements of the list.",
"type": "array",
"items": {
- "$ref": "SplitInt64"
+ "type": "string"
}
}
},
- "id": "IntegerList"
+ "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": {
+ "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.",
+ "type": "string"
+ },
+ "shortStrValue": {
+ "description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.",
+ "type": "string"
+ },
+ "label": {
+ "description": "An optional label to display in a dax UI for the element.",
+ "type": "string"
+ },
+ "url": {
+ "description": "An optional full URL.",
+ "type": "string"
+ },
+ "timestampValue": {
+ "description": "Contains value if the data is of timestamp type.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "Contains value if the data is of a boolean type.",
+ "type": "boolean"
+ },
+ "javaClassValue": {
+ "description": "Contains value if the data is of java class type.",
+ "type": "string"
+ },
+ "strValue": {
+ "type": "string",
+ "description": "Contains value if the data is of string type."
+ },
+ "durationValue": {
+ "description": "Contains value if the data is of duration type.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "int64Value": {
+ "description": "Contains value if the data is of int64 type.",
+ "format": "int64",
+ "type": "string"
+ },
+ "namespace": {
+ "type": "string",
+ "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."
+ },
+ "floatValue": {
+ "type": "number",
+ "description": "Contains value if the data is of float type.",
+ "format": "float"
+ }
+ }
+ },
+ "LeaseWorkItemRequest": {
+ "description": "Request to lease WorkItems.",
+ "type": "object",
+ "properties": {
+ "currentWorkerTime": {
+ "type": "string",
+ "description": "The current timestamp at the worker.",
+ "format": "google-datetime"
+ },
+ "workItemTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Filter for WorkItem type."
+ },
+ "location": {
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string"
+ },
+ "workerCapabilities": {
+ "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "workerId": {
+ "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.",
+ "type": "string"
+ },
+ "requestedLeaseDuration": {
+ "description": "The initial lease period.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "LeaseWorkItemRequest"
+ },
+ "GetDebugConfigRequest": {
+ "description": "Request to get updated debug configuration for component.",
+ "type": "object",
+ "properties": {
+ "workerId": {
+ "description": "The worker id, i.e., VM hostname.",
+ "type": "string"
+ },
+ "componentId": {
+ "description": "The internal component id for which debug configuration is\nrequested.",
+ "type": "string"
+ }
+ },
+ "id": "GetDebugConfigRequest"
+ },
+ "GetTemplateResponse": {
+ "description": "The response to a GetTemplate request.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "TemplateMetadata",
+ "description": "The template metadata describing the template name, available\nparameters, etc."
+ },
+ "status": {
+ "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details.",
+ "$ref": "Status"
+ }
+ },
+ "id": "GetTemplateResponse"
+ },
+ "ReportWorkItemStatusRequest": {
+ "description": "Request to report the status of WorkItems.",
+ "type": "object",
+ "properties": {
+ "workItemStatuses": {
+ "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.",
+ "type": "array",
+ "items": {
+ "$ref": "WorkItemStatus"
+ }
+ },
+ "workerId": {
+ "type": "string",
+ "description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service\nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response)."
+ },
+ "currentWorkerTime": {
+ "description": "The current timestamp at the worker.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location which contains the WorkItem's job.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "executionPipelineStage": {
+ "description": "Description of each stage of execution of the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "ExecutionStageSummary"
+ }
+ },
+ "originalPipelineTransform": {
+ "type": "array",
+ "items": {
+ "$ref": "TransformSummary"
+ },
+ "description": "Description of each transform in the pipeline and collections between them."
+ },
+ "displayData": {
+ "description": "Pipeline level display data.",
+ "type": "array",
+ "items": {
+ "$ref": "DisplayData"
+ }
+ }
+ },
+ "id": "PipelineDescription"
+ },
+ "StreamingConfigTask": {
+ "description": "A task that carries configuration information for streaming computations.",
+ "type": "object",
+ "properties": {
+ "userStepToStateFamilyNameMap": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Map from user step names to state families."
+ },
+ "streamingComputationConfigs": {
+ "description": "Set of computation configuration information.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamingComputationConfig"
+ }
+ }
+ },
+ "id": "StreamingConfigTask"
+ },
+ "JobExecutionInfo": {
+ "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
+ "type": "object",
+ "properties": {
+ "stages": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "JobExecutionStageInfo"
+ },
+ "description": "A mapping from each stage to the information about that stage."
+ }
+ },
+ "id": "JobExecutionInfo"
+ },
+ "Step": {
+ "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.",
+ "type": "string"
+ },
+ "kind": {
+ "description": "The kind of step in the Cloud Dataflow job.",
+ "type": "string"
+ }
+ },
+ "id": "Step"
+ },
+ "FailedLocation": {
+ "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"
+ }
+ },
+ "id": "FailedLocation"
+ },
+ "Disk": {
+ "description": "Describes the data disk used by a workflow job.",
+ "type": "object",
+ "properties": {
+ "sizeGb": {
+ "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "diskType": {
+ "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard",
+ "type": "string"
+ },
+ "mountPoint": {
+ "description": "Directory in a VM where disk is mounted.",
+ "type": "string"
+ }
+ },
+ "id": "Disk"
+ },
+ "CounterMetadata": {
+ "description": "CounterMetadata includes all static non-name non-value counter attributes.",
+ "type": "object",
+ "properties": {
+ "standardUnits": {
+ "enumDescriptions": [
+ "Counter returns a value in bytes.",
+ "Counter returns a value in bytes per second.",
+ "Counter returns a value in milliseconds.",
+ "Counter returns a value in microseconds.",
+ "Counter returns a value in nanoseconds.",
+ "Counter returns a timestamp in milliseconds.",
+ "Counter returns a timestamp in microseconds.",
+ "Counter returns a timestamp in nanoseconds."
+ ],
+ "enum": [
+ "BYTES",
+ "BYTES_PER_SEC",
+ "MILLISECONDS",
+ "MICROSECONDS",
+ "NANOSECONDS",
+ "TIMESTAMP_MSEC",
+ "TIMESTAMP_USEC",
+ "TIMESTAMP_NSEC"
+ ],
+ "description": "System defined Units, see above enum.",
+ "type": "string"
+ },
+ "otherUnits": {
+ "description": "A string referring to the unit type.",
+ "type": "string"
+ },
+ "kind": {
+ "enumDescriptions": [
+ "Counter aggregation kind was not set.",
+ "Aggregated value is the sum of all contributed values.",
+ "Aggregated value is the max of all contributed values.",
+ "Aggregated value is the min of all contributed values.",
+ "Aggregated value is the mean of all contributed values.",
+ "Aggregated value represents the logical 'or' of all contributed values.",
+ "Aggregated value represents the logical 'and' of all contributed values.",
+ "Aggregated value is a set of unique contributed values.",
+ "Aggregated value captures statistics about a distribution."
+ ],
+ "enum": [
+ "INVALID",
+ "SUM",
+ "MAX",
+ "MIN",
+ "MEAN",
+ "OR",
+ "AND",
+ "SET",
+ "DISTRIBUTION"
+ ],
+ "description": "Counter aggregation kind.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Human-readable description of the counter semantics.",
+ "type": "string"
+ }
+ },
+ "id": "CounterMetadata"
+ },
+ "ListJobMessagesResponse": {
+ "description": "Response to a request to list job messages.",
+ "type": "object",
+ "properties": {
+ "jobMessages": {
+ "description": "Messages in ascending timestamp order.",
+ "type": "array",
+ "items": {
+ "$ref": "JobMessage"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token to obtain the next page of results if there are more.",
+ "type": "string"
+ }
+ },
+ "id": "ListJobMessagesResponse"
+ },
+ "ApproximateReportedProgress": {
+ "description": "A progress measurement of a WorkItem by a worker.",
+ "type": "object",
+ "properties": {
+ "position": {
+ "$ref": "Position",
+ "description": "A Position within the work to represent a progress."
+ },
+ "fractionConsumed": {
+ "description": "Completion as fraction of the input consumed, from 0.0 (beginning, nothing\nconsumed), to 1.0 (end of the input, entire input consumed).",
+ "format": "double",
+ "type": "number"
+ },
+ "consumedParallelism": {
+ "$ref": "ReportedParallelism",
+ "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite."
+ },
+ "remainingParallelism": {
+ "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.",
+ "$ref": "ReportedParallelism"
+ }
+ },
+ "id": "ApproximateReportedProgress"
},
"StateFamilyConfig": {
"description": "State family configuration.",
@@ -1171,73 +3354,71 @@
},
"id": "StateFamilyConfig"
},
+ "IntegerList": {
+ "type": "object",
+ "properties": {
+ "elements": {
+ "description": "Elements of the list.",
+ "type": "array",
+ "items": {
+ "$ref": "SplitInt64"
+ }
+ }
+ },
+ "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.",
- "type": "object"
+ "description": "Service-side response to WorkerMessage reporting resource utilization."
},
"SourceSplitResponse": {
"id": "SourceSplitResponse",
"description": "The response to a SourceSplitRequest.",
"type": "object",
"properties": {
- "shards": {
- "type": "array",
- "items": {
- "$ref": "SourceSplitShard"
- },
- "description": "DEPRECATED in favor of bundles."
- },
"outcome": {
- "enumDescriptions": [
- "The source split outcome is unknown, or unspecified.",
- "The current source should be processed \"as is\" without splitting.",
- "Splitting produced a list of bundles."
- ],
"enum": [
"SOURCE_SPLIT_OUTCOME_UNKNOWN",
"SOURCE_SPLIT_OUTCOME_USE_CURRENT",
"SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED"
],
"description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The source split outcome is unknown, or unspecified.",
+ "The current source should be processed \"as is\" without splitting.",
+ "Splitting produced a list of bundles."
+ ]
},
"bundles": {
+ "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is ignored.\nThis list can be empty, which means the source represents an empty input.",
"type": "array",
"items": {
"$ref": "DerivedSource"
- },
- "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."
+ }
+ },
+ "shards": {
+ "description": "DEPRECATED in favor of bundles.",
+ "type": "array",
+ "items": {
+ "$ref": "SourceSplitShard"
+ }
}
}
},
"ParallelInstruction": {
- "description": "Describes a particular operation comprising a MapTask.",
"type": "object",
"properties": {
- "partialGroupByKey": {
- "$ref": "PartialGroupByKeyInstruction",
- "description": "Additional information for PartialGroupByKey instructions."
- },
- "outputs": {
- "description": "Describes the outputs of the instruction.",
- "type": "array",
- "items": {
- "$ref": "InstructionOutput"
- }
- },
- "name": {
- "type": "string",
- "description": "User-provided name of this operation."
- },
"parDo": {
- "$ref": "ParDoInstruction",
- "description": "Additional information for ParDo instructions."
+ "description": "Additional information for ParDo instructions.",
+ "$ref": "ParDoInstruction"
},
"read": {
- "description": "Additional information for Read instructions.",
- "$ref": "ReadInstruction"
+ "$ref": "ReadInstruction",
+ "description": "Additional information for Read instructions."
},
"flatten": {
"description": "Additional information for Flatten instructions.",
@@ -1254,30 +3435,28 @@
"systemName": {
"description": "System-defined name of this operation.\nUnique across the workflow.",
"type": "string"
- }
- },
- "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": {
- "start": {
- "type": "string",
- "description": "The start (inclusive) of the key range."
},
- "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"
+ "partialGroupByKey": {
+ "$ref": "PartialGroupByKeyInstruction",
+ "description": "Additional information for PartialGroupByKey instructions."
},
- "end": {
- "description": "The end (exclusive) of the key range.",
+ "outputs": {
+ "description": "Describes the outputs of the instruction.",
+ "type": "array",
+ "items": {
+ "$ref": "InstructionOutput"
+ }
+ },
+ "name": {
+ "description": "User-provided name of this operation.",
"type": "string"
}
},
- "id": "KeyRangeDataDiskAssignment"
+ "id": "ParallelInstruction",
+ "description": "Describes a particular operation comprising a MapTask."
},
"Package": {
+ "id": "Package",
"description": "The packages that must be installed in order for a worker to run the\nsteps of the Cloud Dataflow job that will be assigned to its worker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes code to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmight use this to install jars containing the user's code and all of the\nvarious dependencies (libraries, data files, etc.) required in order\nfor that code to run.",
"type": "object",
"properties": {
@@ -1286,17 +3465,53 @@
"type": "string"
},
"name": {
- "type": "string",
- "description": "The name of the package."
+ "description": "The name of the package.",
+ "type": "string"
+ }
+ }
+ },
+ "KeyRangeDataDiskAssignment": {
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "The end (exclusive) of the key range.",
+ "type": "string"
+ },
+ "start": {
+ "description": "The start (inclusive) of the key range.",
+ "type": "string"
+ },
+ "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"
}
},
- "id": "Package"
+ "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."
},
"ParDoInstruction": {
+ "id": "ParDoInstruction",
+ "description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code.",
+ "type": "object",
"properties": {
+ "multiOutputInfos": {
+ "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
+ "type": "array",
+ "items": {
+ "$ref": "MultiOutputInfo"
+ }
+ },
+ "userFn": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
+ },
"input": {
- "description": "The input.",
- "$ref": "InstructionInput"
+ "$ref": "InstructionInput",
+ "description": "The input."
},
"numOutputs": {
"description": "The number of outputs.",
@@ -1309,31 +3524,83 @@
"items": {
"$ref": "SideInputInfo"
}
- },
- "multiOutputInfos": {
- "description": "Information about each of the outputs, if user_fn is a MultiDoFn.",
- "type": "array",
- "items": {
- "$ref": "MultiOutputInfo"
- }
- },
- "userFn": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object."
- },
- "description": "The user function to invoke."
}
- },
- "id": "ParDoInstruction",
- "description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code.",
- "type": "object"
+ }
+ },
+ "CounterStructuredName": {
+ "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",
+ "properties": {
+ "componentStepName": {
+ "description": "Name of the optimized step being executed by the workers.",
+ "type": "string"
+ },
+ "portion": {
+ "enumDescriptions": [
+ "Counter portion has not been set.",
+ "Counter reports a key.",
+ "Counter reports a value."
+ ],
+ "enum": [
+ "ALL",
+ "KEY",
+ "VALUE"
+ ],
+ "description": "Portion of this counter, either key or value.",
+ "type": "string"
+ },
+ "originalStepName": {
+ "description": "System generated name of the original step in the user's graph, before\noptimization.",
+ "type": "string"
+ },
+ "workerId": {
+ "description": "ID of a particular worker.",
+ "type": "string"
+ },
+ "originNamespace": {
+ "description": "A string containing a more specific namespace of the counter's origin.",
+ "type": "string"
+ },
+ "executionStepName": {
+ "description": "Name of the stage. An execution step contains multiple component steps.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
+ "type": "string"
+ },
+ "origin": {
+ "enumDescriptions": [
+ "Counter was created by the Dataflow system.",
+ "Counter was created by the user."
+ ],
+ "enum": [
+ "SYSTEM",
+ "USER"
+ ],
+ "description": "One of the standard Origins defined above.",
+ "type": "string"
+ }
+ }
},
"MetricUpdate": {
"description": "Describes the state of a metric.",
"type": "object",
"properties": {
+ "updateTime": {
+ "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "$ref": "MetricStructuredName",
+ "description": "Name of the metric."
+ },
+ "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"
@@ -1357,82 +3624,11 @@
"meanSum": {
"description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.",
"type": "any"
- },
- "updateTime": {
- "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "$ref": "MetricStructuredName",
- "description": "Name of the metric."
- },
- "set": {
- "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type.",
- "type": "any"
}
},
"id": "MetricUpdate"
},
- "CounterStructuredName": {
- "properties": {
- "componentStepName": {
- "description": "Name of the optimized step being executed by the workers.",
- "type": "string"
- },
- "portion": {
- "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"
- ]
- },
- "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"
- },
- "origin": {
- "description": "One of the standard Origins defined above.",
- "type": "string",
- "enumDescriptions": [
- "Counter was created by the Dataflow system.",
- "Counter was created by the user."
- ],
- "enum": [
- "SYSTEM",
- "USER"
- ]
- },
- "executionStepName": {
- "type": "string",
- "description": "Name of the stage. An execution step contains multiple component steps."
- },
- "name": {
- "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.",
- "type": "string"
- }
- },
- "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"
- },
"ApproximateProgress": {
- "type": "object",
"properties": {
"percentComplete": {
"description": "Obsolete.",
@@ -1450,19 +3646,20 @@
}
},
"id": "ApproximateProgress",
- "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest."
+ "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.",
+ "type": "object"
},
"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."
- },
"workerMetricsResponse": {
"$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"
@@ -1472,43 +3669,38 @@
"type": "object",
"properties": {
"bypassTempDirValidation": {
- "description": "If true, will bypass the validation that the temp directory is\nwritable. This should only be used with templates for pipelines\nthat are guaranteed not to need to write to the temp directory,\nwhich is subject to change based on the optimizer.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "If true, will bypass the validation that the temp directory is\nwritable. This should only be used with templates for pipelines\nthat are guaranteed not to need to write to the temp directory,\nwhich is subject to change based on the optimizer."
},
"name": {
"description": "Required. The name of the template.",
"type": "string"
},
"parameters": {
+ "description": "The parameters for the template.",
"type": "array",
"items": {
"$ref": "ParameterMetadata"
- },
- "description": "The parameters for the template."
+ }
},
"description": {
- "type": "string",
- "description": "Optional. A description of the template."
+ "description": "Optional. A description of the template.",
+ "type": "string"
}
},
"id": "TemplateMetadata"
},
"WorkerMessage": {
- "id": "WorkerMessage",
"description": "WorkerMessage provides information to the backend about a worker.",
"type": "object",
"properties": {
- "workerHealthReport": {
- "$ref": "WorkerHealthReport",
- "description": "The health of a worker."
- },
"workerMessageCode": {
"$ref": "WorkerMessageCode",
"description": "A worker message code."
},
"workerMetrics": {
- "description": "Resource metrics reported by workers.",
- "$ref": "ResourceUtilizationReport"
+ "$ref": "ResourceUtilizationReport",
+ "description": "Resource metrics reported by workers."
},
"labels": {
"additionalProperties": {
@@ -1521,12 +3713,15 @@
"description": "The timestamp of the worker_message.",
"format": "google-datetime",
"type": "string"
+ },
+ "workerHealthReport": {
+ "$ref": "WorkerHealthReport",
+ "description": "The health of a worker."
}
- }
+ },
+ "id": "WorkerMessage"
},
"JobMetrics": {
- "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.",
- "type": "object",
"properties": {
"metricTime": {
"description": "Timestamp as of which metric values are current.",
@@ -1541,9 +3736,12 @@
}
}
},
- "id": "JobMetrics"
+ "id": "JobMetrics",
+ "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.",
+ "type": "object"
},
"FloatingPointList": {
+ "id": "FloatingPointList",
"description": "A metric value representing a list of floating point numbers.",
"type": "object",
"properties": {
@@ -1555,41 +3753,49 @@
"type": "number"
}
}
- },
- "id": "FloatingPointList"
+ }
},
"CounterUpdate": {
+ "id": "CounterUpdate",
"description": "An update to a Counter sent from a worker.",
"type": "object",
"properties": {
- "integerList": {
- "$ref": "IntegerList",
- "description": "List of integers, for Set."
+ "floatingPointList": {
+ "$ref": "FloatingPointList",
+ "description": "List of floating point numbers, for Set."
+ },
+ "integer": {
+ "description": "Integer value for Sum, Max, Min.",
+ "$ref": "SplitInt64"
},
"structuredNameAndMetadata": {
"description": "Counter structured name and metadata.",
"$ref": "CounterStructuredNameAndMetadata"
},
+ "integerList": {
+ "$ref": "IntegerList",
+ "description": "List of integers, for Set."
+ },
"integerMean": {
- "description": "Integer mean aggregation value for Mean.",
- "$ref": "IntegerMean"
+ "$ref": "IntegerMean",
+ "description": "Integer mean aggregation value for Mean."
},
"floatingPoint": {
"description": "Floating point value for Sum, Max, Min.",
"format": "double",
"type": "number"
},
+ "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"
},
- "internal": {
- "type": "any",
- "description": "Value for internally-defined counters used by the Dataflow service."
- },
"floatingPointMean": {
- "$ref": "FloatingPointMean",
- "description": "Floating point mean aggregation value for Mean."
+ "description": "Floating point mean aggregation value for Mean.",
+ "$ref": "FloatingPointMean"
},
"boolean": {
"description": "Boolean value for And, Or.",
@@ -1611,21 +3817,10 @@
"description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job.",
"format": "int64",
"type": "string"
- },
- "floatingPointList": {
- "description": "List of floating point numbers, for Set.",
- "$ref": "FloatingPointList"
- },
- "integer": {
- "description": "Integer value for Sum, Max, Min.",
- "$ref": "SplitInt64"
}
- },
- "id": "CounterUpdate"
+ }
},
"SourceMetadata": {
- "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
- "type": "object",
"properties": {
"producesSortedKeys": {
"description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.",
@@ -1641,17 +3836,21 @@
"type": "string"
}
},
- "id": "SourceMetadata"
+ "id": "SourceMetadata",
+ "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.",
+ "type": "object"
},
"DistributionUpdate": {
+ "description": "A metric value representing a distribution.",
+ "type": "object",
"properties": {
"count": {
- "description": "The count of the number of elements present in the distribution.",
- "$ref": "SplitInt64"
+ "$ref": "SplitInt64",
+ "description": "The count of the number of elements present in the distribution."
},
"min": {
- "description": "The minimum value present in the distribution.",
- "$ref": "SplitInt64"
+ "$ref": "SplitInt64",
+ "description": "The minimum value present in the distribution."
},
"sumOfSquares": {
"description": "Use a double since the sum of squares is likely to overflow int64.",
@@ -1663,23 +3862,19 @@
"description": "The maximum value present in the distribution."
},
"sum": {
- "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double.",
- "$ref": "SplitInt64"
+ "$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"
+ "id": "DistributionUpdate"
},
"SourceFork": {
+ "description": "DEPRECATED in favor of DynamicSourceSplit.",
+ "type": "object",
"properties": {
- "primarySource": {
- "$ref": "DerivedSource",
- "description": "DEPRECATED"
- },
"residual": {
- "$ref": "SourceSplitShard",
- "description": "DEPRECATED"
+ "description": "DEPRECATED",
+ "$ref": "SourceSplitShard"
},
"residualSource": {
"$ref": "DerivedSource",
@@ -1688,13 +3883,16 @@
"primary": {
"description": "DEPRECATED",
"$ref": "SourceSplitShard"
+ },
+ "primarySource": {
+ "description": "DEPRECATED",
+ "$ref": "DerivedSource"
}
},
- "id": "SourceFork",
- "description": "DEPRECATED in favor of DynamicSourceSplit.",
- "type": "object"
+ "id": "SourceFork"
},
"WorkerHealthReportResponse": {
+ "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping.",
"type": "object",
"properties": {
"reportInterval": {
@@ -1703,17 +3901,12 @@
"type": "string"
}
},
- "id": "WorkerHealthReportResponse",
- "description": "WorkerHealthReportResponse contains information returned to the worker\nin response to a health ping."
+ "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."
- },
"counterUpdates": {
"description": "Worker output counters for this WorkItem.",
"type": "array",
@@ -1722,15 +3915,8 @@
}
},
"workItemId": {
- "description": "Identifies the WorkItem.",
- "type": "string"
- },
- "metricUpdates": {
- "description": "DEPRECATED in favor of counter_updates.",
- "type": "array",
- "items": {
- "$ref": "MetricUpdate"
- }
+ "type": "string",
+ "description": "Identifies the WorkItem."
},
"errors": {
"description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.",
@@ -1739,13 +3925,20 @@
"$ref": "Status"
}
},
+ "metricUpdates": {
+ "description": "DEPRECATED in favor of counter_updates.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricUpdate"
+ }
+ },
"dynamicSourceSplit": {
"description": "See documentation of stop_position.",
"$ref": "DynamicSourceSplit"
},
"sourceOperationResponse": {
- "$ref": "SourceOperationResponse",
- "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation."
+ "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation.",
+ "$ref": "SourceOperationResponse"
},
"progress": {
"$ref": "ApproximateProgress",
@@ -1762,8 +3955,8 @@
"type": "string"
},
"stopPosition": {
- "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc.",
- "$ref": "Position"
+ "$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).",
@@ -1772,33 +3965,42 @@
"reportedProgress": {
"$ref": "ApproximateReportedProgress",
"description": "The worker's progress through this WorkItem."
+ },
+ "sourceFork": {
+ "$ref": "SourceFork",
+ "description": "DEPRECATED in favor of dynamic_source_split."
}
},
"id": "WorkItemStatus"
},
"ComponentSource": {
- "description": "Description of an interstitial value between transforms in an execution\nstage.",
- "type": "object",
"properties": {
+ "originalTransformOrCollection": {
+ "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
+ "type": "string"
+ },
"name": {
"description": "Dataflow service generated name for this source.",
"type": "string"
},
"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"
+ "type": "string",
+ "description": "Human-readable name for this transform; may be user or system generated."
}
},
- "id": "ComponentSource"
+ "id": "ComponentSource",
+ "description": "Description of an interstitial value between transforms in an execution\nstage.",
+ "type": "object"
},
"WorkItemServiceState": {
"description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.",
"type": "object",
"properties": {
+ "nextReportIndex": {
+ "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
+ "format": "int64",
+ "type": "string"
+ },
"suggestedStopPoint": {
"description": "DEPRECATED in favor of split_request.",
"$ref": "ApproximateProgress"
@@ -1807,15 +4009,15 @@
"$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": {
"description": "New recommended reporting interval.",
"format": "google-duration",
"type": "string"
},
+ "suggestedStopPosition": {
+ "$ref": "Position",
+ "description": "Obsolete, always empty."
+ },
"harnessData": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1835,11 +4037,6 @@
"items": {
"$ref": "MetricShortId"
}
- },
- "nextReportIndex": {
- "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.",
- "format": "int64",
- "type": "string"
}
},
"id": "WorkItemServiceState"
@@ -1849,15 +4046,15 @@
"type": "object",
"properties": {
"context": {
- "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",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e."
},
"origin": {
- "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.",
- "type": "string"
+ "type": "string",
+ "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."
},
"name": {
"description": "Worker-defined metric name.",
@@ -1867,6 +4064,8 @@
"id": "MetricStructuredName"
},
"SeqMapTaskOutputInfo": {
+ "description": "Information about an output of a SeqMapTask.",
+ "type": "object",
"properties": {
"sink": {
"$ref": "Sink",
@@ -1877,20 +4076,18 @@
"type": "string"
}
},
- "id": "SeqMapTaskOutputInfo",
- "description": "Information about an output of a SeqMapTask.",
- "type": "object"
+ "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.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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"
@@ -1908,8 +4105,8 @@
"type": "string"
},
"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\"."
},
"persistentDirectory": {
"description": "The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.",
@@ -1937,6 +4134,10 @@
"description": "Basic metadata about a counter.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Name of the counter.",
+ "type": "string"
+ },
"kind": {
"enumDescriptions": [
"Counter aggregation kind was not set.",
@@ -1962,36 +4163,15 @@
],
"description": "Counter aggregation kind.",
"type": "string"
- },
- "name": {
- "description": "Name of the counter.",
- "type": "string"
}
},
"id": "NameAndKind"
},
"SeqMapTask": {
+ "id": "SeqMapTask",
+ "description": "Describes a particular function to invoke.",
"type": "object",
"properties": {
- "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"
- },
- "outputInfos": {
- "description": "Information about each of the outputs.",
- "type": "array",
- "items": {
- "$ref": "SeqMapTaskOutputInfo"
- }
- },
"inputs": {
"description": "Information about each of the inputs.",
"type": "array",
@@ -2006,31 +4186,49 @@
"systemName": {
"description": "System-defined name of the SeqDo operation.\nUnique across the workflow.",
"type": "string"
+ },
+ "userFn": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The user function to invoke.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The user-provided name of the SeqDo operation.",
+ "type": "string"
+ },
+ "outputInfos": {
+ "description": "Information about each of the outputs.",
+ "type": "array",
+ "items": {
+ "$ref": "SeqMapTaskOutputInfo"
+ }
}
- },
- "id": "SeqMapTask",
- "description": "Describes a particular function to invoke."
+ }
},
"WorkerMessageCode": {
- "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).",
"type": "object",
"properties": {
"parameters": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
"description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.",
- "type": "object"
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ }
},
"code": {
- "type": "string",
- "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."
+ "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.",
+ "type": "string"
}
},
- "id": "WorkerMessageCode"
+ "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": {
@@ -2038,10 +4236,11 @@
"type": "boolean"
}
},
- "id": "CustomSourceLocation",
- "description": "Identifies the location of a custom souce."
+ "id": "CustomSourceLocation"
},
"MapTask": {
+ "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
+ "type": "object",
"properties": {
"systemName": {
"description": "System-defined name of this MapTask.\nUnique across the workflow.",
@@ -2059,11 +4258,11 @@
}
}
},
- "id": "MapTask",
- "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.",
- "type": "object"
+ "id": "MapTask"
},
"FloatingPointMean": {
+ "description": "A representation of a floating point mean metric contribution.",
+ "type": "object",
"properties": {
"count": {
"$ref": "SplitInt64",
@@ -2075,9 +4274,7 @@
"type": "number"
}
},
- "id": "FloatingPointMean",
- "description": "A representation of a floating point mean metric contribution.",
- "type": "object"
+ "id": "FloatingPointMean"
},
"ReportWorkItemStatusResponse": {
"type": "object",
@@ -2094,21 +4291,10 @@
"description": "Response from a request to report the status of WorkItems."
},
"InstructionOutput": {
+ "id": "InstructionOutput",
"description": "An output of an instruction.",
"type": "object",
"properties": {
- "codec": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The codec to use to encode data being written via this output.",
- "type": "object"
- },
- "name": {
- "description": "The user-provided name of this output.",
- "type": "string"
- },
"originalName": {
"description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.",
"type": "string"
@@ -2122,52 +4308,63 @@
"description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size."
},
"onlyCountValueBytes": {
- "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size."
+ },
+ "codec": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The codec to use to encode data being written via this output.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The user-provided name of this output.",
+ "type": "string"
}
- },
- "id": "InstructionOutput"
+ }
},
"CreateJobFromTemplateRequest": {
- "description": "A request to create a Cloud Dataflow job from a template.",
"type": "object",
"properties": {
"environment": {
- "description": "The runtime environment for the job.",
- "$ref": "RuntimeEnvironment"
+ "$ref": "RuntimeEnvironment",
+ "description": "The runtime environment for the job."
},
"parameters": {
- "description": "The runtime parameters to pass to the job.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "The runtime parameters to pass to the job.",
+ "type": "object"
},
"jobName": {
- "type": "string",
- "description": "Required. The job name to use for the created job."
+ "description": "Required. The job name to use for the created job.",
+ "type": "string"
},
"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://`."
+ "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"
}
},
- "id": "CreateJobFromTemplateRequest"
+ "id": "CreateJobFromTemplateRequest",
+ "description": "A request to create a Cloud Dataflow job from a template."
},
"IntegerMean": {
+ "id": "IntegerMean",
"description": "A representation of an integer mean metric contribution.",
"type": "object",
"properties": {
+ "sum": {
+ "description": "The sum of all values being aggregated.",
+ "$ref": "SplitInt64"
+ },
"count": {
"$ref": "SplitInt64",
"description": "The number of values being aggregated."
- },
- "sum": {
- "$ref": "SplitInt64",
- "description": "The sum of all values being aggregated."
}
- },
- "id": "IntegerMean"
+ }
},
"ListJobsResponse": {
"description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.",
@@ -2201,13 +4398,6 @@
"description": "The user stage name.",
"type": "string"
},
- "outputs": {
- "type": "array",
- "items": {
- "$ref": "StreamLocation"
- },
- "description": "The outputs from the computation."
- },
"stateFamilies": {
"description": "The state family values.",
"type": "array",
@@ -2215,9 +4405,16 @@
"$ref": "StateFamilyConfig"
}
},
+ "outputs": {
+ "description": "The outputs from the computation.",
+ "type": "array",
+ "items": {
+ "$ref": "StreamLocation"
+ }
+ },
"systemStageName": {
- "type": "string",
- "description": "The system stage name."
+ "description": "The system stage name.",
+ "type": "string"
},
"inputs": {
"description": "The inputs to the computation.",
@@ -2240,2203 +4437,6 @@
},
"id": "ComputationTopology",
"description": "All configuration data for a particular Computation."
- },
- "RuntimeEnvironment": {
- "type": "object",
- "properties": {
- "maxWorkers": {
- "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.",
- "format": "int32",
- "type": "integer"
- },
- "zone": {
- "description": "The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "RuntimeEnvironment",
- "description": "The environment values to set at runtime."
- },
- "StreamingSideInputLocation": {
- "description": "Identifies the location of a streaming side input.",
- "type": "object",
- "properties": {
- "tag": {
- "description": "Identifies the particular side input within the streaming Dataflow job.",
- "type": "string"
- },
- "stateFamily": {
- "description": "Identifies the state family where this side input is stored.",
- "type": "string"
- }
- },
- "id": "StreamingSideInputLocation"
- },
- "MountedDataDisk": {
- "description": "Describes mounted data disk.",
- "type": "object",
- "properties": {
- "dataDisk": {
- "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".",
- "type": "string"
- }
- },
- "id": "MountedDataDisk"
- },
- "LaunchTemplateResponse": {
- "type": "object",
- "properties": {
- "job": {
- "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched.",
- "$ref": "Job"
- },
- "status": {
- "$ref": "Status",
- "description": "The status of the launch template request. Any problems with the request\nwill be indicated in the error_details."
- }
- },
- "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": {
- "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`."
- ],
- "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"
- ],
- "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state.",
- "type": "string"
- },
- "tempFiles": {
- "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "clientRequestId": {
- "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.",
- "type": "string"
- },
- "name": {
- "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])?`"
- },
- "replacedByJobId": {
- "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.",
- "type": "string"
- },
- "steps": {
- "type": "array",
- "items": {
- "$ref": "Step"
- },
- "description": "The top-level steps that constitute the entire job."
- },
- "id": {
- "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.",
- "type": "string"
- },
- "executionInfo": {
- "$ref": "JobExecutionInfo",
- "description": "Deprecated."
- },
- "currentState": {
- "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"
- ],
- "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`."
- ]
- },
- "location": {
- "description": "The location that contains this job.",
- "type": "string"
- },
- "currentStateTime": {
- "type": "string",
- "description": "The timestamp associated with the current state.",
- "format": "google-datetime"
- },
- "transformNameMapping": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.",
- "type": "object"
- },
- "createTime": {
- "type": "string",
- "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.",
- "format": "google-datetime"
- },
- "environment": {
- "description": "The environment for the job.",
- "$ref": "Environment"
- },
- "labels": {
- "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "projectId": {
- "description": "The ID of the Cloud Platform project that the job belongs to.",
- "type": "string"
- },
- "type": {
- "enum": [
- "JOB_TYPE_UNKNOWN",
- "JOB_TYPE_BATCH",
- "JOB_TYPE_STREAMING"
- ],
- "description": "The type of Cloud Dataflow job.",
- "type": "string",
- "enumDescriptions": [
- "The type of the job is unspecified, or unknown.",
- "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.",
- "A continuously streaming job with no end: data is read,\nprocessed, and written continuously."
- ]
- },
- "pipelineDescription": {
- "$ref": "PipelineDescription",
- "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
- }
- },
- "id": "Job"
- },
- "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": {
- "primary": {
- "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current.",
- "$ref": "DerivedSource"
- },
- "residual": {
- "$ref": "DerivedSource",
- "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source."
- }
- },
- "id": "DynamicSourceSplit"
- },
- "DerivedSource": {
- "properties": {
- "derivationMode": {
- "enum": [
- "SOURCE_DERIVATION_MODE_UNKNOWN",
- "SOURCE_DERIVATION_MODE_INDEPENDENT",
- "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT",
- "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT"
- ],
- "description": "What source to base the produced source on (if any).",
- "type": "string",
- "enumDescriptions": [
- "The source derivation is unknown, or unspecified.",
- "Produce a completely independent Source with no base.",
- "Produce a Source based on the Source being split.",
- "Produce a Source based on the base of the Source being split."
- ]
- },
- "source": {
- "description": "Specification of the source.",
- "$ref": "Source"
- }
- },
- "id": "DerivedSource",
- "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.",
- "type": "object"
- },
- "SourceOperationResponse": {
- "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.",
- "type": "object",
- "properties": {
- "split": {
- "description": "A response to a request to split a source.",
- "$ref": "SourceSplitResponse"
- },
- "getMetadata": {
- "$ref": "SourceGetMetadataResponse",
- "description": "A response to a request to get metadata about a source."
- }
- },
- "id": "SourceOperationResponse"
- },
- "SendDebugCaptureResponse": {
- "id": "SendDebugCaptureResponse",
- "description": "Response to a send capture request.\nnothing",
- "type": "object",
- "properties": {}
- },
- "SideInputInfo": {
- "properties": {
- "sources": {
- "type": "array",
- "items": {
- "$ref": "Source"
- },
- "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required."
- },
- "kind": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "How to interpret the source element(s) as a side input value.",
- "type": "object"
- },
- "tag": {
- "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.",
- "type": "string"
- }
- },
- "id": "SideInputInfo",
- "description": "Information about a side input of a DoFn or an input of a SeqDoFn.",
- "type": "object"
- },
- "CounterStructuredNameAndMetadata": {
- "description": "A single message which encapsulates structured name and metadata for a given\ncounter.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "CounterMetadata",
- "description": "Metadata associated with a counter"
- },
- "name": {
- "description": "Structured name of the counter.",
- "$ref": "CounterStructuredName"
- }
- },
- "id": "CounterStructuredNameAndMetadata"
- },
- "ConcatPosition": {
- "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",
- "properties": {
- "position": {
- "$ref": "Position",
- "description": "Position within the inner source."
- },
- "index": {
- "description": "Index of the inner source.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "WriteInstruction": {
- "properties": {
- "input": {
- "$ref": "InstructionInput",
- "description": "The input."
- },
- "sink": {
- "description": "The sink to write to.",
- "$ref": "Sink"
- }
- },
- "id": "WriteInstruction",
- "description": "An instruction that writes records.\nTakes one input, produces no outputs.",
- "type": "object"
- },
- "StreamingComputationRanges": {
- "description": "Describes full or partial data disk assignment information of the computation\nranges.",
- "type": "object",
- "properties": {
- "rangeAssignments": {
- "description": "Data disk assignments for ranges from this computation.",
- "type": "array",
- "items": {
- "$ref": "KeyRangeDataDiskAssignment"
- }
- },
- "computationId": {
- "description": "The ID of the computation.",
- "type": "string"
- }
- },
- "id": "StreamingComputationRanges"
- },
- "AutoscalingSettings": {
- "properties": {
- "algorithm": {
- "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.",
- "type": "string"
- },
- "maxNumWorkers": {
- "type": "integer",
- "description": "The maximum number of workers to cap scaling at.",
- "format": "int32"
- }
- },
- "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": {
- "componentTransform": {
- "description": "Transforms that comprise this execution stage.",
- "type": "array",
- "items": {
- "$ref": "ComponentTransform"
- }
- },
- "componentSource": {
- "description": "Collections produced and consumed by component transforms of this stage.",
- "type": "array",
- "items": {
- "$ref": "ComponentSource"
- }
- },
- "kind": {
- "description": "Type of tranform this stage is executing.",
- "type": "string",
- "enumDescriptions": [
- "Unrecognized transform type.",
- "ParDo transform.",
- "Group By Key transform.",
- "Flatten transform.",
- "Read transform.",
- "Write transform.",
- "Constructs from a constant value, such as with Create.of.",
- "Creates a Singleton view of a collection.",
- "Opening or closing a shuffle session, often as part of a GroupByKey."
- ],
- "enum": [
- "UNKNOWN_KIND",
- "PAR_DO_KIND",
- "GROUP_BY_KEY_KIND",
- "FLATTEN_KIND",
- "READ_KIND",
- "WRITE_KIND",
- "CONSTANT_KIND",
- "SINGLETON_KIND",
- "SHUFFLE_KIND"
- ]
- },
- "outputSource": {
- "description": "Output sources for this stage.",
- "type": "array",
- "items": {
- "$ref": "StageSource"
- }
- },
- "name": {
- "description": "Dataflow service generated name for this stage.",
- "type": "string"
- },
- "inputSource": {
- "description": "Input sources for this stage.",
- "type": "array",
- "items": {
- "$ref": "StageSource"
- }
- },
- "id": {
- "description": "Dataflow service generated id for this stage.",
- "type": "string"
- }
- },
- "id": "ExecutionStageSummary"
- },
- "SendWorkerMessagesRequest": {
- "properties": {
- "workerMessages": {
- "description": "The WorkerMessages to send.",
- "type": "array",
- "items": {
- "$ref": "WorkerMessage"
- }
- }
- },
- "id": "SendWorkerMessagesRequest",
- "description": "A request for sending worker messages to the service.",
- "type": "object"
- },
- "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": {
- "timestamp": {
- "description": "Timestamp of the measurement.",
- "format": "google-datetime",
- "type": "string"
- },
- "totalMs": {
- "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.",
- "format": "uint64",
- "type": "string"
- },
- "rate": {
- "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "CPUTime"
- },
- "Environment": {
- "description": "Describes the environment in which a Dataflow Job runs.",
- "type": "object",
- "properties": {
- "clusterManagerApiService": {
- "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".",
- "type": "string"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "workerPools": {
- "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.",
- "type": "array",
- "items": {
- "$ref": "WorkerPool"
- }
- },
- "dataset": {
- "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}",
- "type": "string"
- },
- "experiments": {
- "description": "The list of experiments to enable.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "version": {
- "description": "A structure describing which components and their versions of the service\nare required in order to run the job.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "internalExperiments": {
- "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"
- },
- "sdkPipelineOptions": {
- "type": "object",
- "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."
- },
- "userAgent": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "A description of the process that generated the request."
- }
- },
- "id": "Environment"
- },
- "StreamingComputationTask": {
- "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.",
- "type": "object",
- "properties": {
- "dataDisks": {
- "description": "Describes the set of data disks this task should apply to.",
- "type": "array",
- "items": {
- "$ref": "MountedDataDisk"
- }
- },
- "taskType": {
- "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)."
- ],
- "enum": [
- "STREAMING_COMPUTATION_TASK_UNKNOWN",
- "STREAMING_COMPUTATION_TASK_STOP",
- "STREAMING_COMPUTATION_TASK_START"
- ],
- "description": "A type of streaming computation task."
- },
- "computationRanges": {
- "description": "Contains ranges of a streaming computation this task should apply to.",
- "type": "array",
- "items": {
- "$ref": "StreamingComputationRanges"
- }
- }
- },
- "id": "StreamingComputationTask"
- },
- "SendDebugCaptureRequest": {
- "description": "Request to send encoded debug information.",
- "type": "object",
- "properties": {
- "componentId": {
- "type": "string",
- "description": "The internal component id for which debug information is sent."
- },
- "workerId": {
- "type": "string",
- "description": "The worker id, i.e., VM hostname."
- },
- "data": {
- "description": "The encoded debug information.",
- "type": "string"
- }
- },
- "id": "SendDebugCaptureRequest"
- },
- "GetDebugConfigResponse": {
- "type": "object",
- "properties": {
- "config": {
- "description": "The encoded debug configuration for the requested component.",
- "type": "string"
- }
- },
- "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": {
- "type": "string",
- "description": "User name for the original user transform with which this transform is\nmost closely associated."
- },
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- },
- "userName": {
- "description": "Human-readable name for this transform; may be user or system generated.",
- "type": "string"
- }
- },
- "id": "ComponentTransform"
- },
- "StreamingSetupTask": {
- "properties": {
- "workerHarnessPort": {
- "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.",
- "format": "int32",
- "type": "integer"
- },
- "drain": {
- "description": "The user has requested drain.",
- "type": "boolean"
- },
- "receiveWorkPort": {
- "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.",
- "format": "int32",
- "type": "integer"
- },
- "streamingComputationTopology": {
- "description": "The global topology of the streaming Dataflow job.",
- "$ref": "TopologyConfig"
- }
- },
- "id": "StreamingSetupTask",
- "description": "A task which initializes part of a streaming Dataflow job.",
- "type": "object"
- },
- "PubsubLocation": {
- "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.",
- "type": "object",
- "properties": {
- "dropLateData": {
- "description": "Indicates whether the pipeline allows late-arriving data.",
- "type": "boolean"
- },
- "trackingSubscription": {
- "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.",
- "type": "string"
- },
- "withAttributes": {
- "type": "boolean",
- "description": "If true, then the client has requested to get pubsub attributes."
- },
- "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": {
- "type": "string",
- "description": "A pubsub topic, in the form of\n\"pubsub.googleapis.com/topics/\u003cproject-id\u003e/\u003ctopic-name\u003e\""
- },
- "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"
- }
- },
- "id": "PubsubLocation"
- },
- "WorkerHealthReport": {
- "id": "WorkerHealthReport",
- "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.",
- "type": "object",
- "properties": {
- "pods": {
- "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- }
- },
- "vmStartupTime": {
- "description": "The time the VM was booted.",
- "format": "google-datetime",
- "type": "string"
- },
- "vmIsHealthy": {
- "description": "Whether the VM is healthy.",
- "type": "boolean"
- },
- "reportInterval": {
- "type": "string",
- "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.",
- "format": "google-duration"
- }
- }
- },
- "JobMessage": {
- "description": "A particular message pertaining to a Dataflow job.",
- "type": "object",
- "properties": {
- "time": {
- "description": "The timestamp of the message.",
- "format": "google-datetime",
- "type": "string"
- },
- "id": {
- "description": "Identifies the message. This is automatically generated by the\nservice; the caller should treat it as an opaque string.",
- "type": "string"
- },
- "messageText": {
- "description": "The text of the message.",
- "type": "string"
- },
- "messageImportance": {
- "enum": [
- "JOB_MESSAGE_IMPORTANCE_UNKNOWN",
- "JOB_MESSAGE_DEBUG",
- "JOB_MESSAGE_DETAILED",
- "JOB_MESSAGE_BASIC",
- "JOB_MESSAGE_WARNING",
- "JOB_MESSAGE_ERROR"
- ],
- "description": "Importance level of the message.",
- "type": "string",
- "enumDescriptions": [
- "The message importance isn't specified, or is unknown.",
- "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.",
- "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.",
- "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.",
- "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.",
- "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI."
- ]
- }
- },
- "id": "JobMessage"
- },
- "ParameterMetadata": {
- "description": "Metadata for a specific parameter.",
- "type": "object",
- "properties": {
- "isOptional": {
- "description": "Optional. Whether the parameter is optional. Defaults to false.",
- "type": "boolean"
- },
- "name": {
- "description": "Required. The name of the parameter.",
- "type": "string"
- },
- "regexes": {
- "description": "Optional. Regexes that the parameter must match.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "label": {
- "description": "Required. The label to display for the parameter.",
- "type": "string"
- },
- "helpText": {
- "description": "Required. The help text to display for the parameter.",
- "type": "string"
- }
- },
- "id": "ParameterMetadata"
- },
- "MultiOutputInfo": {
- "description": "Information about an output of a multi-output DoFn.",
- "type": "object",
- "properties": {
- "tag": {
- "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.",
- "type": "string"
- }
- },
- "id": "MultiOutputInfo"
- },
- "SourceSplitRequest": {
- "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it.",
- "type": "object",
- "properties": {
- "source": {
- "$ref": "Source",
- "description": "Specification of the source to be split."
- },
- "options": {
- "$ref": "SourceSplitOptions",
- "description": "Hints for tuning the splitting process."
- }
- },
- "id": "SourceSplitRequest"
- },
- "SourceGetMetadataResponse": {
- "type": "object",
- "properties": {
- "metadata": {
- "description": "The computed metadata.",
- "$ref": "SourceMetadata"
- }
- },
- "id": "SourceGetMetadataResponse",
- "description": "The result of a SourceGetMetadataOperation."
- },
- "MetricShortId": {
- "properties": {
- "metricIndex": {
- "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.",
- "format": "int32",
- "type": "integer"
- },
- "shortId": {
- "description": "The service-generated short identifier for the metric.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "MetricShortId",
- "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest",
- "type": "object"
- },
- "ShellTask": {
- "description": "A task which consists of a shell command for the worker to execute.",
- "type": "object",
- "properties": {
- "command": {
- "description": "The shell command to run.",
- "type": "string"
- },
- "exitCode": {
- "description": "Exit code for the task.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ShellTask"
- },
- "TaskRunnerSettings": {
- "description": "Taskrunner configuration settings.",
- "type": "object",
- "properties": {
- "logUploadLocation": {
- "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "streamingWorkerMainClass": {
- "description": "The streaming worker main class name.",
- "type": "string"
- },
- "workflowFileName": {
- "description": "The file to store the workflow in.",
- "type": "string"
- },
- "baseTaskDir": {
- "description": "The location on the worker for task-specific subdirectories.",
- "type": "string"
- },
- "tempStoragePrefix": {
- "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}",
- "type": "string"
- },
- "commandlinesFileName": {
- "description": "The file to store preprocessing commands in.",
- "type": "string"
- },
- "languageHint": {
- "description": "The suggested backend language.",
- "type": "string"
- },
- "baseUrl": {
- "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
- "type": "string"
- },
- "logToSerialconsole": {
- "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole.",
- "type": "boolean"
- },
- "continueOnException": {
- "description": "Whether to continue taskrunner if an exception is hit.",
- "type": "boolean"
- },
- "parallelWorkerSettings": {
- "$ref": "WorkerSettings",
- "description": "The settings to pass to the parallel worker harness."
- },
- "vmId": {
- "description": "The ID string of the VM.",
- "type": "string"
- },
- "taskUser": {
- "type": "string",
- "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"."
- },
- "alsologtostderr": {
- "description": "Whether to also send taskrunner log info to stderr.",
- "type": "boolean"
- },
- "taskGroup": {
- "description": "The UNIX group ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"wheel\".",
- "type": "string"
- },
- "harnessCommand": {
- "description": "The command to launch the worker harness.",
- "type": "string"
- },
- "logDir": {
- "description": "The directory on the VM to store logs.",
- "type": "string"
- },
- "oauthScopes": {
- "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "dataflowApiVersion": {
- "description": "The API version of endpoint, e.g. \"v1b3\"",
- "type": "string"
- }
- },
- "id": "TaskRunnerSettings"
- },
- "Position": {
- "description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index.",
- "type": "object",
- "properties": {
- "shufflePosition": {
- "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).",
- "type": "string"
- },
- "concatPosition": {
- "description": "CloudPosition is a concat position.",
- "$ref": "ConcatPosition"
- },
- "byteOffset": {
- "description": "Position is a byte offset.",
- "format": "int64",
- "type": "string"
- },
- "end": {
- "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.",
- "type": "boolean"
- },
- "key": {
- "description": "Position is a string key, ordered lexicographically.",
- "type": "string"
- },
- "recordIndex": {
- "description": "Position is a record index.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Position"
- },
- "Source": {
- "id": "Source",
- "description": "A source that records can be read and decoded from.",
- "type": "object",
- "properties": {
- "baseSpecs": {
- "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- }
- },
- "codec": {
- "description": "The codec to use to decode data read from the source.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "doesNotNeedSplitting": {
- "description": "Setting this value to true hints to the framework that the source\ndoesn't need splitting, and using SourceSplitRequest on it would\nyield SOURCE_SPLIT_OUTCOME_USE_CURRENT.\n\nE.g. a file splitter may set this to true when splitting a single file\ninto a set of byte ranges of appropriate size, and set this\nto false when splitting a filepattern into individual files.\nHowever, for efficiency, a file splitter may decide to produce\nfile subranges directly from the filepattern to avoid a splitting\nround-trip.\n\nSee SourceSplitRequest for an overview of the splitting process.\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated.",
- "type": "boolean"
- },
- "spec": {
- "description": "The source to read from, plus its parameters.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "metadata": {
- "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated.",
- "$ref": "SourceMetadata"
- }
- }
- },
- "SplitInt64": {
- "type": "object",
- "properties": {
- "lowBits": {
- "description": "The low order bits: n & 0xffffffff.",
- "format": "uint32",
- "type": "integer"
- },
- "highBits": {
- "description": "The high order bits, including the sign: n \u003e\u003e 32.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "SplitInt64",
- "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON."
- },
- "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": {
- "dataDisks": {
- "description": "Data disks that are used by a VM in this workflow.",
- "type": "array",
- "items": {
- "$ref": "Disk"
- }
- },
- "subnetwork": {
- "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".",
- "type": "string"
- },
- "ipConfiguration": {
- "enumDescriptions": [
- "The configuration is unknown, or unspecified.",
- "Workers should have public IP addresses.",
- "Workers should have private IP addresses."
- ],
- "enum": [
- "WORKER_IP_UNSPECIFIED",
- "WORKER_IP_PUBLIC",
- "WORKER_IP_PRIVATE"
- ],
- "description": "Configuration for VM IPs.",
- "type": "string"
- },
- "autoscalingSettings": {
- "$ref": "AutoscalingSettings",
- "description": "Settings for autoscaling of this WorkerPool."
- },
- "taskrunnerSettings": {
- "$ref": "TaskRunnerSettings",
- "description": "Settings passed through to Google Compute Engine workers when\nusing the standard Dataflow task runner. Users should ignore\nthis field."
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata to set on the Google Compute Engine VMs.",
- "type": "object"
- },
- "defaultPackageSet": {
- "description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.",
- "type": "string",
- "enumDescriptions": [
- "The default set of packages to stage is unknown, or unspecified.",
- "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.",
- "Stage packages typically useful to workers written in Java.",
- "Stage pacakges typically useful to workers written in Python."
- ],
- "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"
- },
- "zone": {
- "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.",
- "type": "string"
- },
- "numWorkers": {
- "type": "integer",
- "description": "Number of Google Compute Engine workers in this pool needed to\nexecute the job. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32"
- },
- "numThreadsPerWorker": {
- "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).",
- "format": "int32",
- "type": "integer"
- },
- "diskSourceImage": {
- "description": "Fully qualified source image for disks.",
- "type": "string"
- },
- "packages": {
- "description": "Packages to be installed on workers.",
- "type": "array",
- "items": {
- "$ref": "Package"
- }
- },
- "teardownPolicy": {
- "type": "string",
- "enumDescriptions": [
- "The teardown policy isn't specified, or is unknown.",
- "Always teardown the resource.",
- "Teardown the resource on success. This is useful for debugging\nfailures.",
- "Never teardown the resource. This is useful for debugging and\ndevelopment."
- ],
- "enum": [
- "TEARDOWN_POLICY_UNKNOWN",
- "TEARDOWN_ALWAYS",
- "TEARDOWN_ON_SUCCESS",
- "TEARDOWN_NEVER"
- ],
- "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault."
- },
- "onHostMaintenance": {
- "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.",
- "type": "string"
- },
- "poolArgs": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "Extra arguments for this worker pool.",
- "type": "object"
- },
- "diskSizeGb": {
- "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32",
- "type": "integer"
- },
- "workerHarnessContainerImage": {
- "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.",
- "type": "string"
- },
- "machineType": {
- "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.",
- "type": "string"
- },
- "diskType": {
- "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.",
- "type": "string"
- },
- "kind": {
- "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.",
- "type": "string"
- }
- },
- "id": "WorkerPool"
- },
- "SourceOperationRequest": {
- "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.",
- "type": "object",
- "properties": {
- "getMetadata": {
- "description": "Information about a request to get metadata about a source.",
- "$ref": "SourceGetMetadataRequest"
- },
- "split": {
- "description": "Information about a request to split a source.",
- "$ref": "SourceSplitRequest"
- }
- },
- "id": "SourceOperationRequest"
- },
- "WorkItem": {
- "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.",
- "type": "object",
- "properties": {
- "reportStatusInterval": {
- "description": "Recommended reporting interval.",
- "format": "google-duration",
- "type": "string"
- },
- "streamingSetupTask": {
- "$ref": "StreamingSetupTask",
- "description": "Additional information for StreamingSetupTask WorkItems."
- },
- "sourceOperationTask": {
- "description": "Additional information for source operation WorkItems.",
- "$ref": "SourceOperationRequest"
- },
- "streamingConfigTask": {
- "$ref": "StreamingConfigTask",
- "description": "Additional information for StreamingConfigTask WorkItems."
- },
- "leaseExpireTime": {
- "type": "string",
- "description": "Time when the lease on this Work will expire.",
- "format": "google-datetime"
- },
- "initialReportIndex": {
- "description": "The initial index to use when reporting the status of the WorkItem.",
- "format": "int64",
- "type": "string"
- },
- "shellTask": {
- "description": "Additional information for ShellTask WorkItems.",
- "$ref": "ShellTask"
- },
- "streamingComputationTask": {
- "$ref": "StreamingComputationTask",
- "description": "Additional information for StreamingComputationTask WorkItems."
- },
- "jobId": {
- "description": "Identifies the workflow job this WorkItem belongs to.",
- "type": "string"
- },
- "id": {
- "description": "Identifies this WorkItem.",
- "format": "int64",
- "type": "string"
- },
- "configuration": {
- "type": "string",
- "description": "Work item-specific configuration as an opaque blob."
- },
- "mapTask": {
- "description": "Additional information for MapTask WorkItems.",
- "$ref": "MapTask"
- },
- "seqMapTask": {
- "description": "Additional information for SeqMapTask WorkItems.",
- "$ref": "SeqMapTask"
- },
- "packages": {
- "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.",
- "type": "array",
- "items": {
- "$ref": "Package"
- }
- },
- "projectId": {
- "description": "Identifies the cloud project this WorkItem belongs to.",
- "type": "string"
- }
- },
- "id": "WorkItem"
- },
- "ReportedParallelism": {
- "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.",
- "type": "object",
- "properties": {
- "isInfinite": {
- "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.",
- "type": "boolean"
- },
- "value": {
- "description": "Specifies the level of parallelism in case it is finite.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "ReportedParallelism"
- },
- "ResourceUtilizationReport": {
- "properties": {
- "cpuTime": {
- "description": "CPU utilization samples.",
- "type": "array",
- "items": {
- "$ref": "CPUTime"
- }
- }
- },
- "id": "ResourceUtilizationReport",
- "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.",
- "type": "object"
- },
- "TopologyConfig": {
- "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations.",
- "type": "object",
- "properties": {
- "forwardingKeyBits": {
- "description": "The size (in bits) of keys that will be assigned to source messages.",
- "format": "int32",
- "type": "integer"
- },
- "userStageToComputationNameMap": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Maps user stage names to stable computation names.",
- "type": "object"
- },
- "computations": {
- "description": "The computations associated with a streaming Dataflow job.",
- "type": "array",
- "items": {
- "$ref": "ComputationTopology"
- }
- },
- "dataDiskAssignments": {
- "description": "The disks assigned to a streaming Dataflow job.",
- "type": "array",
- "items": {
- "$ref": "DataDiskAssignment"
- }
- },
- "persistentStateVersion": {
- "type": "integer",
- "description": "Version number for persistent state.",
- "format": "int32"
- }
- },
- "id": "TopologyConfig"
- },
- "SourceSplitOptions": {
- "type": "object",
- "properties": {
- "desiredBundleSizeBytes": {
- "description": "The source should be split into a set of bundles where the estimated size\nof each is approximately this many bytes.",
- "format": "int64",
- "type": "string"
- },
- "desiredShardSizeBytes": {
- "description": "DEPRECATED in favor of desired_bundle_size_bytes.",
- "format": "int64",
- "type": "string"
- }
- },
- "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": {
- "description": "The source to read from.",
- "$ref": "Source"
- }
- },
- "id": "ReadInstruction"
- },
- "WorkerSettings": {
- "id": "WorkerSettings",
- "description": "Provides data to pass through to the worker harness.",
- "type": "object",
- "properties": {
- "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}"
- },
- "baseUrl": {
- "description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"",
- "type": "string"
- },
- "reportingEnabled": {
- "description": "Whether to send work progress updates to the service.",
- "type": "boolean"
- },
- "servicePath": {
- "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".",
- "type": "string"
- },
- "shuffleServicePath": {
- "type": "string",
- "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\"."
- },
- "workerId": {
- "description": "The ID of the worker running this pipeline.",
- "type": "string"
- }
- }
- },
- "DataDiskAssignment": {
- "description": "Data disk assignment for a given VM instance.",
- "type": "object",
- "properties": {
- "vmInstance": {
- "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".",
- "type": "string"
- },
- "dataDisks": {
- "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "DataDiskAssignment"
- },
- "StreamingStageLocation": {
- "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.",
- "type": "object",
- "properties": {
- "streamId": {
- "description": "Identifies the particular stream within the streaming Dataflow\njob.",
- "type": "string"
- }
- },
- "id": "StreamingStageLocation"
- },
- "ApproximateSplitRequest": {
- "description": "A suggestion by the service to the worker to dynamically split the WorkItem.",
- "type": "object",
- "properties": {
- "position": {
- "$ref": "Position",
- "description": "A Position at which to split the work item."
- },
- "fractionConsumed": {
- "description": "A fraction at which to split the work item, from 0.0 (beginning of the\ninput) to 1.0 (end of the input).",
- "format": "double",
- "type": "number"
- }
- },
- "id": "ApproximateSplitRequest"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
- },
- "details": {
- "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Status"
- },
- "StreamLocation": {
- "properties": {
- "customSourceLocation": {
- "$ref": "CustomSourceLocation",
- "description": "The stream is a custom source."
- },
- "streamingStageLocation": {
- "description": "The stream is part of another computation within the current\nstreaming Dataflow job.",
- "$ref": "StreamingStageLocation"
- },
- "pubsubLocation": {
- "$ref": "PubsubLocation",
- "description": "The stream is a pubsub stream."
- },
- "sideInputLocation": {
- "$ref": "StreamingSideInputLocation",
- "description": "The stream is a streaming side input."
- }
- },
- "id": "StreamLocation",
- "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.",
- "type": "object"
- },
- "SendWorkerMessagesResponse": {
- "type": "object",
- "properties": {
- "workerMessageResponses": {
- "description": "The servers response to the worker messages.",
- "type": "array",
- "items": {
- "$ref": "WorkerMessageResponse"
- }
- }
- },
- "id": "SendWorkerMessagesResponse",
- "description": "The response to the worker messages."
- },
- "LeaseWorkItemResponse": {
- "properties": {
- "workItems": {
- "description": "A list of the leased WorkItems.",
- "type": "array",
- "items": {
- "$ref": "WorkItem"
- }
- }
- },
- "id": "LeaseWorkItemResponse",
- "description": "Response to a request to lease WorkItems.",
- "type": "object"
- },
- "TransformSummary": {
- "description": "Description of the type, names/ids, and input/outputs for a transform.",
- "type": "object",
- "properties": {
- "inputCollectionName": {
- "description": "User names for all collection inputs to this transform.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "name": {
- "description": "User provided name for this transform instance.",
- "type": "string"
- },
- "id": {
- "description": "SDK generated id of this transform instance.",
- "type": "string"
- },
- "displayData": {
- "description": "Transform-specific display data.",
- "type": "array",
- "items": {
- "$ref": "DisplayData"
- }
- },
- "outputCollectionName": {
- "description": "User names for all collection outputs to this transform.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "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 transform.",
- "type": "string"
- }
- },
- "id": "TransformSummary"
- },
- "StreamingComputationConfig": {
- "description": "Configuration information for a single streaming computation.",
- "type": "object",
- "properties": {
- "computationId": {
- "description": "Unique identifier for this computation.",
- "type": "string"
- },
- "systemName": {
- "description": "System defined name for this computation.",
- "type": "string"
- },
- "stageName": {
- "type": "string",
- "description": "Stage name of this computation."
- },
- "instructions": {
- "description": "Instructions that comprise the computation.",
- "type": "array",
- "items": {
- "$ref": "ParallelInstruction"
- }
- }
- },
- "id": "StreamingComputationConfig"
- },
- "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"
- },
- "LaunchTemplateParameters": {
- "description": "Parameters to provide to the template being launched.",
- "type": "object",
- "properties": {
- "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"
- },
- "environment": {
- "description": "The runtime environment for the job.",
- "$ref": "RuntimeEnvironment"
- }
- },
- "id": "LaunchTemplateParameters"
- },
- "FlattenInstruction": {
- "type": "object",
- "properties": {
- "inputs": {
- "type": "array",
- "items": {
- "$ref": "InstructionInput"
- },
- "description": "Describes the inputs to the flatten instruction."
- }
- },
- "id": "FlattenInstruction",
- "description": "An instruction that copies its inputs (zero or more) to its (single) output."
- },
- "PartialGroupByKeyInstruction": {
- "id": "PartialGroupByKeyInstruction",
- "description": "An instruction that does a partial group-by-key.\nOne input and one output.",
- "type": "object",
- "properties": {
- "inputElementCodec": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The codec to use for interpreting an element in the input PTable.",
- "type": "object"
- },
- "valueCombiningFn": {
- "description": "The value combining function to invoke.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- }
- },
- "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"
- },
- "originalCombineValuesStepName": {
- "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction.",
- "type": "string"
- },
- "sideInputs": {
- "description": "Zero or more side inputs.",
- "type": "array",
- "items": {
- "$ref": "SideInputInfo"
- }
- },
- "input": {
- "description": "Describes the input to the partial group-by-key instruction.",
- "$ref": "InstructionInput"
- }
- }
- },
- "StageSource": {
- "type": "object",
- "properties": {
- "originalTransformOrCollection": {
- "description": "User name for the original user transform or collection with which this\nsource is most closely associated.",
- "type": "string"
- },
- "name": {
- "description": "Dataflow service generated name for this source.",
- "type": "string"
- },
- "sizeBytes": {
- "description": "Size of the source, if measurable.",
- "format": "int64",
- "type": "string"
- },
- "userName": {
- "description": "Human-readable name for this source; may be user or system generated.",
- "type": "string"
- }
- },
- "id": "StageSource",
- "description": "Description of an input or output of an execution stage."
- },
- "InstructionInput": {
- "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.",
- "type": "object",
- "properties": {
- "producerInstructionIndex": {
- "type": "integer",
- "description": "The index (origin zero) of the parallel instruction that produces\nthe output to be consumed by this input. This index is relative\nto the list of instructions in this input's instruction's\ncontaining MapTask.",
- "format": "int32"
- },
- "outputNum": {
- "description": "The output index (origin zero) within the producer.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "InstructionInput"
- },
- "StringList": {
- "description": "A metric value representing a list of strings.",
- "type": "object",
- "properties": {
- "elements": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Elements of the list."
- }
- },
- "id": "StringList"
- },
- "DisplayData": {
- "description": "Data provided with a pipeline or transform to provide descriptive info.",
- "type": "object",
- "properties": {
- "shortStrValue": {
- "description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.",
- "type": "string"
- },
- "label": {
- "description": "An optional label to display in a dax UI for the element.",
- "type": "string"
- },
- "url": {
- "description": "An optional full URL.",
- "type": "string"
- },
- "timestampValue": {
- "description": "Contains value if the data is of timestamp type.",
- "format": "google-datetime",
- "type": "string"
- },
- "boolValue": {
- "description": "Contains value if the data is of a boolean type.",
- "type": "boolean"
- },
- "javaClassValue": {
- "description": "Contains value if the data is of java class type.",
- "type": "string"
- },
- "strValue": {
- "description": "Contains value if the data is of string type.",
- "type": "string"
- },
- "durationValue": {
- "description": "Contains value if the data is of duration type.",
- "format": "google-duration",
- "type": "string"
- },
- "int64Value": {
- "description": "Contains value if the data is of int64 type.",
- "format": "int64",
- "type": "string"
- },
- "namespace": {
- "description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering.",
- "type": "string"
- },
- "floatValue": {
- "description": "Contains value if the data is of float type.",
- "format": "float",
- "type": "number"
- },
- "key": {
- "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.",
- "type": "string"
- }
- },
- "id": "DisplayData"
- },
- "LeaseWorkItemRequest": {
- "description": "Request to lease WorkItems.",
- "type": "object",
- "properties": {
- "currentWorkerTime": {
- "description": "The current timestamp at the worker.",
- "format": "google-datetime",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "type": "string"
- },
- "workItemTypes": {
- "description": "Filter for WorkItem type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "workerCapabilities": {
- "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "workerId": {
- "type": "string",
- "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker."
- },
- "requestedLeaseDuration": {
- "description": "The initial lease period.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "LeaseWorkItemRequest"
- },
- "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"
- }
- },
- "id": "GetDebugConfigRequest"
- },
- "GetTemplateResponse": {
- "description": "The response to a GetTemplate request.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "The template metadata describing the template name, available\nparameters, etc.",
- "$ref": "TemplateMetadata"
- },
- "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"
- },
- "ReportWorkItemStatusRequest": {
- "id": "ReportWorkItemStatusRequest",
- "description": "Request to report the status of WorkItems.",
- "type": "object",
- "properties": {
- "workerId": {
- "description": "The ID of the worker reporting the WorkItem status. If this\ndoes not match the ID of the worker which the Dataflow service\nbelieves currently has the lease on the WorkItem, the report\nwill be dropped (with an error response).",
- "type": "string"
- },
- "currentWorkerTime": {
- "description": "The current timestamp at the worker.",
- "format": "google-datetime",
- "type": "string"
- },
- "location": {
- "description": "The location which contains the WorkItem's job.",
- "type": "string"
- },
- "workItemStatuses": {
- "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.",
- "type": "array",
- "items": {
- "$ref": "WorkItemStatus"
- }
- }
- }
- },
- "PipelineDescription": {
- "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.",
- "type": "object",
- "properties": {
- "displayData": {
- "description": "Pipeline level display data.",
- "type": "array",
- "items": {
- "$ref": "DisplayData"
- }
- },
- "executionPipelineStage": {
- "description": "Description of each stage of execution of the pipeline.",
- "type": "array",
- "items": {
- "$ref": "ExecutionStageSummary"
- }
- },
- "originalPipelineTransform": {
- "description": "Description of each transform in the pipeline and collections between them.",
- "type": "array",
- "items": {
- "$ref": "TransformSummary"
- }
- }
- },
- "id": "PipelineDescription"
- },
- "StreamingConfigTask": {
- "properties": {
- "userStepToStateFamilyNameMap": {
- "description": "Map from user step names to state families.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "streamingComputationConfigs": {
- "description": "Set of computation configuration information.",
- "type": "array",
- "items": {
- "$ref": "StreamingComputationConfig"
- }
- }
- },
- "id": "StreamingConfigTask",
- "description": "A task that carries configuration information for streaming computations.",
- "type": "object"
- },
- "JobExecutionInfo": {
- "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job.",
- "type": "object",
- "properties": {
- "stages": {
- "description": "A mapping from each stage to the information about that stage.",
- "type": "object",
- "additionalProperties": {
- "$ref": "JobExecutionStageInfo"
- }
- }
- },
- "id": "JobExecutionInfo"
- },
- "Step": {
- "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.",
- "type": "object",
- "properties": {
- "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"
- },
- "properties": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.",
- "type": "object"
- }
- },
- "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"
- }
- },
- "id": "FailedLocation"
- },
- "Disk": {
- "description": "Describes the data disk used by a workflow job.",
- "type": "object",
- "properties": {
- "sizeGb": {
- "description": "Size of disk in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.",
- "format": "int32",
- "type": "integer"
- },
- "diskType": {
- "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"
- },
- "mountPoint": {
- "description": "Directory in a VM where disk is mounted.",
- "type": "string"
- }
- },
- "id": "Disk"
- },
- "ListJobMessagesResponse": {
- "type": "object",
- "properties": {
- "jobMessages": {
- "description": "Messages in ascending timestamp order.",
- "type": "array",
- "items": {
- "$ref": "JobMessage"
- }
- },
- "nextPageToken": {
- "description": "The token to obtain the next page of results if there are more.",
- "type": "string"
- }
- },
- "id": "ListJobMessagesResponse",
- "description": "Response to a request to list job messages."
- },
- "CounterMetadata": {
- "description": "CounterMetadata includes all static non-name non-value counter attributes.",
- "type": "object",
- "properties": {
- "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."
- },
- "description": {
- "description": "Human-readable description of the counter semantics.",
- "type": "string"
- },
- "standardUnits": {
- "enumDescriptions": [
- "Counter returns a value in bytes.",
- "Counter returns a value in bytes per second.",
- "Counter returns a value in milliseconds.",
- "Counter returns a value in microseconds.",
- "Counter returns a value in nanoseconds.",
- "Counter returns a timestamp in milliseconds.",
- "Counter returns a timestamp in microseconds.",
- "Counter returns a timestamp in nanoseconds."
- ],
- "enum": [
- "BYTES",
- "BYTES_PER_SEC",
- "MILLISECONDS",
- "MICROSECONDS",
- "NANOSECONDS",
- "TIMESTAMP_MSEC",
- "TIMESTAMP_USEC",
- "TIMESTAMP_NSEC"
- ],
- "description": "System defined Units, see above enum.",
- "type": "string"
- },
- "otherUnits": {
- "description": "A string referring to the unit type.",
- "type": "string"
- }
- },
- "id": "CounterMetadata"
- },
- "ApproximateReportedProgress": {
- "description": "A progress measurement of a WorkItem by a worker.",
- "type": "object",
- "properties": {
- "fractionConsumed": {
- "description": "Completion as fraction of the input consumed, from 0.0 (beginning, nothing\nconsumed), to 1.0 (end of the input, entire input consumed).",
- "format": "double",
- "type": "number"
- },
- "consumedParallelism": {
- "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite.",
- "$ref": "ReportedParallelism"
- },
- "remainingParallelism": {
- "$ref": "ReportedParallelism",
- "description": "Total amount of parallelism in the input of this task that remains,\n(i.e. can be delegated to this task and any new tasks via dynamic\nsplitting). Always at least 1 for non-finished work items and 0 for\nfinished.\n\n\"Amount of parallelism\" refers to how many non-empty parts of the input\ncan be read in parallel. This does not necessarily equal number\nof records. An input that can be read in parallel down to the\nindividual records is called \"perfectly splittable\".\nAn example of non-perfectly parallelizable input is a block-compressed\nfile format where a block of records has to be read as a whole,\nbut different blocks can be read in parallel.\n\nExamples:\n* If we are processing record #30 (starting at 1) out of 50 in a perfectly\n splittable 50-record input, this value should be 21 (20 remaining + 1\n current).\n* If we are reading through block 3 in a block-compressed file consisting\n of 5 blocks, this value should be 3 (since blocks 4 and 5 can be\n processed in parallel by new tasks via dynamic splitting and the current\n task remains processing block 3).\n* If we are reading through the last block in a block-compressed file,\n or reading or processing the last record in a perfectly splittable\n input, this value should be 1, because apart from the current task, no\n additional remainder can be split off."
- },
- "position": {
- "$ref": "Position",
- "description": "A Position within the work to represent a progress."
- }
- },
- "id": "ApproximateReportedProgress"
}
},
"icons": {
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json
index fc90f12..350af79 100644
--- a/dataproc/v1/dataproc-api.json
+++ b/dataproc/v1/dataproc-api.json
@@ -1,22 +1,396 @@
{
- "ownerName": "Google",
- "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"regions": {
"resources": {
- "jobs": {
+ "clusters": {
"methods": {
- "submit": {
+ "diagnose": {
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ },
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
+ },
+ "clusterName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The cluster name."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.regions.clusters.diagnose"
+ },
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "list": {
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
+ },
+ "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 = *"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional The standard List page token."
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional The standard List page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.list",
+ "description": "Lists all regions/{region}/clusters in a project."
+ },
+ "create": {
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters",
+ "description": "Creates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region"
],
"response": {
+ "$ref": "Operation"
+ },
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project the cluster belongs to."
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e and \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e are the only fields that can be updated.",
+ "format": "google-fieldmask"
+ }
+ },
+ "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch",
+ "description": "Updates a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ }
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameters": {
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "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}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "description": "Gets the resource representation for a cluster in a project."
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
+ "location": "path",
+ "description": "The name of the operation collection."
+ },
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "The standard list filter."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
+ "id": "dataproc.projects.regions.operations.list",
+ "path": "v1/{+name}"
+ },
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
+ },
+ "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.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$"
+ }
+ }
+ },
+ "delete": {
+ "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted."
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
+ "path": "v1/{+name}",
+ "id": "dataproc.projects.regions.operations.delete"
+ }
+ }
+ },
+ "jobs": {
+ "methods": {
+ "submit": {
+ "description": "Submits a job to a cluster.",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "response": {
"$ref": "Job"
},
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"location": "path",
@@ -31,20 +405,11 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
"path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "description": "Submits a job to a cluster."
+ "id": "dataproc.projects.regions.jobs.submit"
},
"delete": {
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
- "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
@@ -53,16 +418,8 @@
"region",
"jobId"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "DELETE",
"parameters": {
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
"projectId": {
"location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -70,18 +427,27 @@
"type": "string"
},
"jobId": {
- "description": "Required The job ID.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Required The job ID."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "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/{jobId}",
+ "path": "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": {
- "description": "Lists regions/{region}/jobs in a project.",
"response": {
"$ref": "ListJobsResponse"
},
@@ -91,17 +457,6 @@
],
"httpMethod": "GET",
"parameters": {
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "clusterName": {
- "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
- },
"projectId": {
"location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -114,25 +469,36 @@
"type": "string"
},
"jobStateMatcher": {
+ "type": "string",
"location": "query",
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
],
- "description": "Optional Specifies enumerated categories of jobs to list (default = match ALL jobs).",
- "type": "string"
+ "description": "Optional Specifies enumerated categories of jobs to list (default = match ALL jobs)."
},
"pageToken": {
- "description": "Optional The page token, returned by a previous call, to request the next page of results.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "Optional The page token, returned by a previous call, to request the next page of results."
},
"pageSize": {
- "description": "Optional The number of results to return in each response.",
- "format": "int32",
"type": "integer",
- "location": "query"
+ "location": "query",
+ "description": "Optional The number of results to return in each response.",
+ "format": "int32"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster."
}
},
"scopes": [
@@ -140,13 +506,10 @@
],
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
"path": "v1/projects/{projectId}/regions/{region}/jobs",
- "id": "dataproc.projects.regions.jobs.list"
+ "id": "dataproc.projects.regions.jobs.list",
+ "description": "Lists regions/{region}/jobs in a project."
},
"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"
- },
"httpMethod": "POST",
"parameterOrder": [
"projectId",
@@ -161,27 +524,78 @@
],
"parameters": {
"projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to."
},
"jobId": {
- "description": "Required The job ID.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Required The job ID."
},
"region": {
- "description": "Required The Cloud Dataproc region in which to handle the request.",
"required": true,
"type": "string",
- "location": "path"
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
}
},
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"id": "dataproc.projects.regions.jobs.cancel",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}: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"
+ }
+ },
+ "patch": {
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
+ },
+ "updateMask": {
+ "type": "string",
+ "location": "query",
+ "description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "format": "google-fieldmask"
+ }
+ },
+ "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.patch"
},
"get": {
"response": {
@@ -193,449 +607,33 @@
"jobId"
],
"httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The job ID."
+ },
+ "region": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The Cloud Dataproc region in which to handle the request."
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "jobId": {
- "location": "path",
- "description": "Required The job ID.",
- "required": true,
- "type": "string"
- }
- },
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.get",
"description": "Gets the resource representation for a job in a project."
- },
- "patch": {
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "PATCH",
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "description": "Required The job ID.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch",
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project."
- }
- }
- },
- "clusters": {
- "methods": {
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "updateMask": {
- "location": "query",
- "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e and \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e are the only fields that can be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Updates a cluster in a project."
- },
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "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": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "parameters": {
- "region": {
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}: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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required The cluster name.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- },
- "region": {
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListClustersResponse"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional The standard List page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "filter": {
- "description": "Optional A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "description": "Lists all regions/{region}/clusters in a project."
- },
- "create": {
- "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.",
- "required": true,
- "type": "string"
- },
- "region": {
- "description": "Required The Cloud Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
- "path": "v1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "request": {
- "$ref": "Cluster"
- },
- "description": "Creates a cluster in a project."
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "dataproc.projects.regions.operations.cancel"
- },
- "delete": {
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
- "id": "dataproc.projects.regions.operations.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "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 below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations"
- },
- "get": {
- "id": "dataproc.projects.regions.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}"
}
}
}
@@ -645,82 +643,77 @@
}
},
"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"
+ "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": {
+ "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",
- "description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "bearer_token": {
+ "default": "true",
"location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
+ "description": "Pretty-print response."
},
"oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
},
"upload_protocol": {
- "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",
- "description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "default": "true",
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "type": "string",
+ "location": "query",
+ "description": "JSONP"
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -729,70 +722,50 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
}
},
"schemas": {
- "ClusterConfig": {
+ "PySparkJob": {
+ "description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
+ "type": "object",
"properties": {
- "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"
- },
- "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/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
"type": "array",
"items": {
- "$ref": "NodeInitializationAction"
+ "type": "string"
}
},
- "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"
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional The runtime log config for job execution."
},
- "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."
- }
- },
- "id": "ClusterConfig",
- "description": "The cluster config.",
- "type": "object"
- },
- "PySparkJob": {
- "properties": {
"properties": {
+ "type": "object",
"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"
+ "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."
},
"args": {
- "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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."
},
"fileUris": {
- "description": "Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "description": "Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks."
},
"pythonFileUris": {
"description": "Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
@@ -802,8 +775,8 @@
}
},
"mainPythonFileUri": {
- "description": "Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
- "type": "string"
+ "type": "string",
+ "description": "Required The HCFS URI of the main Python file to use as the driver. Must be a .py file."
},
"archiveUris": {
"description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
@@ -811,47 +784,14 @@
"items": {
"type": "string"
}
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "description": "Optional The runtime log config for job execution.",
- "$ref": "LoggingConfig"
}
},
- "id": "PySparkJob",
- "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"
+ "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": {
- "serviceAccountScopes": {
- "description": "Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "serviceAccount": {
- "description": "Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
- "type": "string"
- },
- "subnetworkUri": {
- "description": "Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.",
- "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). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.",
"type": "string"
@@ -860,37 +800,41 @@
"description": "Required The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone].",
"type": "string"
},
+ "metadata": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata))."
+ },
"internalIpOnly": {
"description": "Optional If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
"type": "boolean"
},
- "metadata": {
- "additionalProperties": {
+ "serviceAccountScopes": {
+ "description": "Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tags": {
+ "type": "array",
+ "items": {
"type": "string"
},
- "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
- "type": "object"
- }
- },
- "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": {
- "acceleratorCount": {
- "description": "The number of the accelerator cards of this type exposed to this instance.",
- "format": "int32",
- "type": "integer"
+ "description": "The Google Compute Engine tags to add to all instances (see Tagging instances)."
},
- "acceleratorTypeUri": {
- "description": "Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)",
+ "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. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.",
"type": "string"
}
},
- "id": "AcceleratorConfig"
+ "id": "GceClusterConfig"
},
"ClusterMetrics": {
"description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
@@ -898,28 +842,44 @@
"properties": {
"yarnMetrics": {
"additionalProperties": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
},
"description": "The YARN metrics.",
"type": "object"
},
"hdfsMetrics": {
+ "type": "object",
"additionalProperties": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
},
- "description": "The HDFS metrics.",
- "type": "object"
+ "description": "The HDFS metrics."
}
},
"id": "ClusterMetrics"
},
+ "AcceleratorConfig": {
+ "type": "object",
+ "properties": {
+ "acceleratorCount": {
+ "type": "integer",
+ "description": "The number of the accelerator cards of this type exposed to this instance.",
+ "format": "int32"
+ },
+ "acceleratorTypeUri": {
+ "type": "string",
+ "description": "Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)"
+ }
+ },
+ "id": "AcceleratorConfig",
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine)."
+ },
"LoggingConfig": {
- "description": "The runtime logging config of the job.",
"type": "object",
"properties": {
"driverLogLevels": {
+ "type": "object",
"additionalProperties": {
"enum": [
"LEVEL_UNSPECIFIED",
@@ -934,35 +894,46 @@
],
"type": "string"
},
- "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
- "type": "object"
+ "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'"
}
},
- "id": "LoggingConfig"
+ "id": "LoggingConfig",
+ "description": "The runtime logging config of the job."
},
"DiagnoseClusterOutputLocation": {
- "properties": {
- "outputUri": {
- "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics.",
- "type": "string"
- }
- },
- "id": "DiagnoseClusterOutputLocation",
"description": "The location where output from diagnostic command can be found.",
- "type": "object"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
- "response": {
+ "outputUri": {
+ "type": "string",
+ "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics."
+ }
+ },
+ "id": "DiagnoseClusterOutputLocation"
+ },
+ "Operation": {
+ "type": "object",
+ "properties": {
+ "metadata": {
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
},
- "description": "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.",
+ "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"
@@ -970,24 +941,12 @@
"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"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a network API call."
},
"OperationStatus": {
- "description": "The status of the operation.",
"type": "object",
"properties": {
"state": {
@@ -1015,70 +974,99 @@
"type": "string"
},
"stateStartTime": {
+ "type": "string",
"description": "The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
+ "format": "google-datetime"
}
},
- "id": "OperationStatus"
+ "id": "OperationStatus",
+ "description": "The status of the operation."
},
"JobReference": {
+ "description": "Encapsulates the full scoping used to reference a job.",
+ "type": "object",
"properties": {
"projectId": {
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string"
},
"jobId": {
- "description": "Optional The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
- "type": "string"
+ "type": "string",
+ "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."
}
},
- "id": "JobReference",
- "description": "Encapsulates the full scoping used to reference a job.",
- "type": "object"
+ "id": "JobReference"
},
"SubmitJobRequest": {
+ "type": "object",
"properties": {
"job": {
- "description": "Required The job resource.",
- "$ref": "Job"
+ "$ref": "Job",
+ "description": "Required The job resource."
}
},
"id": "SubmitJobRequest",
- "description": "A request to submit a job.",
- "type": "object"
+ "description": "A request to submit a job."
},
"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 which 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 purpose.\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 will be a common set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"message": {
- "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
- "type": "string"
+ "type": "string",
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client."
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
+ }
}
},
"id": "Status"
},
+ "JobScheduling": {
+ "type": "object",
+ "properties": {
+ "maxFailuresPerHour": {
+ "type": "integer",
+ "description": "Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
+ "format": "int32"
+ }
+ },
+ "id": "JobScheduling",
+ "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release."
+ },
"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": {
+ "type": "boolean",
+ "description": "Optional Specifies that this instance group contains preemptible instances."
+ },
+ "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."
+ },
+ "machineTypeUri": {
+ "description": "Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
+ "type": "string"
+ },
"instanceNames": {
"description": "Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
"type": "array",
@@ -1094,78 +1082,50 @@
}
},
"numInstances": {
+ "type": "integer",
"description": "Required The number of VM instances in the instance group. For master instance groups, must be set to 1.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"diskConfig": {
- "description": "Optional Disk option config settings.",
- "$ref": "DiskConfig"
- },
- "machineTypeUri": {
- "description": "Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.",
- "type": "string"
- },
- "imageUri": {
- "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
- "type": "string"
- },
- "isPreemptible": {
- "description": "Optional Specifies that this instance group contains preemptible instances.",
- "type": "boolean"
- },
- "managedGroupConfig": {
- "$ref": "ManagedGroupConfig",
- "description": "Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
+ "$ref": "DiskConfig",
+ "description": "Optional Disk option config settings."
}
},
"id": "InstanceGroupConfig"
},
- "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": {
- "description": "Optional Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "JobScheduling"
- },
- "NodeInitializationAction": {
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
- "type": "object",
- "properties": {
- "executionTimeout": {
- "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "format": "google-duration",
- "type": "string"
- },
- "executableFile": {
- "description": "Required Google Cloud Storage URI of executable file.",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction"
- },
"ListJobsResponse": {
+ "description": "A list of jobs in a project.",
+ "type": "object",
"properties": {
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ },
"jobs": {
"description": "Output-only Jobs list.",
"type": "array",
"items": {
"$ref": "Job"
}
- },
- "nextPageToken": {
- "description": "Optional This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
- "type": "string"
}
},
- "id": "ListJobsResponse",
- "description": "A list of jobs in a project.",
- "type": "object"
+ "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": {
+ "type": "string",
+ "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "format": "google-duration"
+ },
+ "executableFile": {
+ "type": "string",
+ "description": "Required Google Cloud Storage URI of executable file."
+ }
+ },
+ "id": "NodeInitializationAction"
},
"CancelJobRequest": {
"description": "A request to cancel a job.",
@@ -1174,13 +1134,15 @@
"id": "CancelJobRequest"
},
"SparkSqlJob": {
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
+ "type": "object",
"properties": {
"scriptVariables": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
- "type": "object"
+ "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";)."
},
"jarFileUris": {
"description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
@@ -1190,33 +1152,38 @@
}
},
"loggingConfig": {
- "description": "Optional The runtime log config for job execution.",
- "$ref": "LoggingConfig"
+ "$ref": "LoggingConfig",
+ "description": "Optional The runtime log config for job execution."
},
"properties": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
+ "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."
},
"queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
+ "$ref": "QueryList",
+ "description": "A list of queries."
},
"queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
+ "type": "string",
+ "description": "The HCFS URI of the script that contains SQL queries."
}
},
- "id": "SparkSqlJob",
- "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
- "type": "object"
+ "id": "SparkSqlJob"
},
"Cluster": {
- "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
+ "metrics": {
+ "$ref": "ClusterMetrics",
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
+ },
+ "status": {
+ "$ref": "ClusterStatus",
+ "description": "Output-only Cluster status."
+ },
"statusHistory": {
"description": "Output-only The previous cluster status.",
"type": "array",
@@ -1229,16 +1196,16 @@
"description": "Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
},
"clusterName": {
- "description": "Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
- "type": "string"
+ "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."
},
"labels": {
"additionalProperties": {
@@ -1246,38 +1213,81 @@
},
"description": "Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
"type": "object"
- },
- "metrics": {
- "$ref": "ClusterMetrics",
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release."
- },
- "status": {
- "$ref": "ClusterStatus",
- "description": "Output-only Cluster status."
}
},
- "id": "Cluster"
+ "id": "Cluster",
+ "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances."
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
}
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
+ "type": "object",
"properties": {
+ "operationType": {
+ "type": "string",
+ "description": "Output-only The operation type."
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
+ },
+ "status": {
+ "$ref": "OperationStatus",
+ "description": "Output-only Current operation status."
+ },
+ "state": {
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
+ "description": "A message containing the operation state.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed."
+ ]
+ },
+ "details": {
+ "type": "string",
+ "description": "A message containing any operation metadata details."
+ },
+ "clusterUuid": {
+ "description": "Cluster UUId for the operation.",
+ "type": "string"
+ },
+ "clusterName": {
+ "description": "Name of the cluster for the operation.",
+ "type": "string"
+ },
+ "innerState": {
+ "description": "A message containing the detailed operation state.",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The time that the operation completed.",
+ "format": "google-datetime"
+ },
"startTime": {
"description": "The time that the operation was started by the server.",
"format": "google-datetime",
@@ -1301,63 +1311,12 @@
"items": {
"$ref": "OperationStatus"
}
- },
- "operationType": {
- "description": "Output-only The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only Short description of operation.",
- "type": "string"
- },
- "status": {
- "$ref": "OperationStatus",
- "description": "Output-only Current operation status."
- },
- "details": {
- "description": "A message containing any operation metadata details.",
- "type": "string"
- },
- "state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is currently running.",
- "The operation is done, either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ],
- "description": "A message containing the operation state.",
- "type": "string"
- },
- "clusterName": {
- "description": "Name of the cluster for the operation.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Cluster UUId for the operation.",
- "type": "string"
- },
- "innerState": {
- "description": "A message containing the detailed operation state.",
- "type": "string"
- },
- "endTime": {
- "description": "The time that the operation completed.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "OperationMetadata",
- "description": "Metadata describing the operation.",
- "type": "object"
+ "description": "Metadata describing the operation."
},
"JobPlacement": {
- "description": "Cloud Dataproc job config.",
"type": "object",
"properties": {
"clusterName": {
@@ -1369,28 +1328,43 @@
"type": "string"
}
},
- "id": "JobPlacement"
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job config."
},
"SoftwareConfig": {
"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": {
+ "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:\ncore: core-site.xml\nhdfs: hdfs-site.xml\nmapred: mapred-site.xml\nyarn: yarn-site.xml\nhive: hive-site.xml\npig: pig.properties\nspark: spark-defaults.conf",
- "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"
+ "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:\ncore: core-site.xml\nhdfs: hdfs-site.xml\nmapred: mapred-site.xml\nyarn: yarn-site.xml\nhive: hive-site.xml\npig: pig.properties\nspark: spark-defaults.conf"
}
},
"id": "SoftwareConfig"
},
"PigJob": {
+ "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
+ "type": "object",
"properties": {
+ "continueOnFailure": {
+ "type": "boolean",
+ "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."
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
+ "queryFileUri": {
+ "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.",
"type": "array",
@@ -1410,42 +1384,28 @@
"description": "Optional The runtime log config for job execution."
},
"properties": {
+ "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"
- },
- "queryFileUri": {
- "description": "The HCFS URI of the script that contains the Pig queries.",
- "type": "string"
- },
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
+ "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."
}
},
- "id": "PigJob",
- "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
- "type": "object"
+ "id": "PigJob"
},
"ClusterStatus": {
- "description": "The status of a cluster and its instances.",
"type": "object",
"properties": {
+ "stateStartTime": {
+ "type": "string",
+ "description": "Output-only Time when this state was entered.",
+ "format": "google-datetime"
+ },
+ "detail": {
+ "type": "string",
+ "description": "Output-only Optional details of cluster's state."
+ },
"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",
@@ -1455,21 +1415,23 @@
"UPDATING"
],
"description": "Output-only The cluster's state.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only Time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "detail": {
- "description": "Output-only Optional details of cluster's state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ]
}
},
- "id": "ClusterStatus"
+ "id": "ClusterStatus",
+ "description": "The status of a cluster and its instances."
},
"ListClustersResponse": {
+ "description": "The list of all clusters in a project.",
+ "type": "object",
"properties": {
"clusters": {
"description": "Output-only The clusters in the project.",
@@ -1479,29 +1441,32 @@
}
},
"nextPageToken": {
- "description": "Output-only This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e."
}
},
- "id": "ListClustersResponse",
- "description": "The list of all clusters in a project.",
- "type": "object"
+ "id": "ListClustersResponse"
},
"SparkJob": {
+ "type": "object",
"properties": {
+ "loggingConfig": {
+ "$ref": "LoggingConfig",
+ "description": "Optional The runtime log config for job execution."
+ },
"properties": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
+ "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."
},
"args": {
- "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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."
},
"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.",
@@ -1511,65 +1476,38 @@
}
},
"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"
+ "type": "string",
+ "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."
},
"archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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.",
"type": "array",
"items": {
"type": "string"
- }
- },
- "loggingConfig": {
- "$ref": "LoggingConfig",
- "description": "Optional The runtime log config for job execution."
+ },
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks."
}
},
"id": "SparkJob",
- "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
- "type": "object"
+ "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": {
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "description": "Job is a Spark job.",
- "$ref": "SparkJob"
- },
- "statusHistory": {
- "description": "Output-only The previous job status.",
- "type": "array",
- "items": {
- "$ref": "JobStatus"
- }
- },
- "yarnApplications": {
- "description": "Output-only The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
- "type": "array",
- "items": {
- "$ref": "YarnApplication"
- }
- },
"pysparkJob": {
- "description": "Job is a Pyspark job.",
- "$ref": "PySparkJob"
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
},
"reference": {
"$ref": "JobReference",
@@ -1588,8 +1526,8 @@
"description": "Required Job information, including how, when, and where to run the job."
},
"driverControlFilesUri": {
- "description": "Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
- "type": "string"
+ "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": {
"$ref": "JobScheduling",
@@ -1600,41 +1538,49 @@
"description": "Job is a Pig job."
},
"hiveJob": {
- "description": "Job is a Hive job.",
- "$ref": "HiveJob"
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.",
- "type": "object"
+ "description": "Optional The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job."
},
"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."
+ },
+ "sparkSqlJob": {
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
+ },
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "statusHistory": {
+ "description": "Output-only The previous job status.",
+ "type": "array",
+ "items": {
+ "$ref": "JobStatus"
+ }
+ },
+ "yarnApplications": {
+ "description": "Output-only The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
+ "type": "array",
+ "items": {
+ "$ref": "YarnApplication"
+ }
}
},
"id": "Job"
},
"JobStatus": {
- "description": "Cloud Dataproc job status.",
"type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "PENDING",
- "SETUP_DONE",
- "RUNNING",
- "CANCEL_PENDING",
- "CANCEL_STARTED",
- "CANCELLED",
- "DONE",
- "ERROR",
- "ATTEMPT_FAILURE"
- ],
- "description": "Output-only A state message specifying the overall job state.",
"type": "string",
"enumDescriptions": [
"The job state is unknown.",
@@ -1647,7 +1593,20 @@
"The job has completed successfully.",
"The job has completed, but encountered an error.",
"Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
- ]
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "SETUP_DONE",
+ "RUNNING",
+ "CANCEL_PENDING",
+ "CANCEL_STARTED",
+ "CANCELLED",
+ "DONE",
+ "ERROR",
+ "ATTEMPT_FAILURE"
+ ],
+ "description": "Output-only A state message specifying the overall job state."
},
"details": {
"description": "Output-only Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
@@ -1659,25 +1618,37 @@
"type": "string"
}
},
- "id": "JobStatus"
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status."
},
"ManagedGroupConfig": {
+ "type": "object",
"properties": {
"instanceGroupManagerName": {
- "description": "Output-only The name of the Instance Group Manager for this group.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only The name of the Instance Group Manager for this group."
},
"instanceTemplateName": {
- "description": "Output-only The name of the Instance Template used for the Managed Instance Group.",
- "type": "string"
+ "type": "string",
+ "description": "Output-only The name of the Instance Template used for the Managed Instance Group."
}
},
"id": "ManagedGroupConfig",
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object"
+ "description": "Specifies the resources used to actively manage an instance group."
},
"ClusterOperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
"properties": {
+ "innerState": {
+ "description": "Output-only A message containing the detailed operation state.",
+ "type": "string"
+ },
+ "stateStartTime": {
+ "type": "string",
+ "description": "Output-only The time this state was entered.",
+ "format": "google-datetime"
+ },
"state": {
"enum": [
"UNKNOWN",
@@ -1695,90 +1666,11 @@
]
},
"details": {
- "description": "Output-onlyA message containing any operation metadata details.",
- "type": "string"
- },
- "innerState": {
- "description": "Output-only A message containing the detailed operation state.",
- "type": "string"
- },
- "stateStartTime": {
- "description": "Output-only The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
+ "type": "string",
+ "description": "Output-onlyA message containing any operation metadata details."
}
},
- "id": "ClusterOperationStatus",
- "description": "The status of the operation.",
- "type": "object"
- },
- "HadoopJob": {
- "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
- "type": "object",
- "properties": {
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
- "type": "object"
- },
- "args": {
- "description": "Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fileUris": {
- "description": "Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfig": {
- "description": "Optional The runtime log config for job execution.",
- "$ref": "LoggingConfig"
- }
- },
- "id": "HadoopJob"
- },
- "QueryList": {
- "properties": {
- "queries": {
- "description": "Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "QueryList",
- "description": "A list of queries to run on a cluster.",
- "type": "object"
+ "id": "ClusterOperationStatus"
},
"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.",
@@ -1826,39 +1718,100 @@
},
"id": "YarnApplication"
},
- "DiagnoseClusterRequest": {
- "properties": {},
- "id": "DiagnoseClusterRequest",
- "description": "A request to collect cluster diagnostic information.",
- "type": "object"
- },
- "DiskConfig": {
- "description": "Specifies the config of disk options for a group of VM instances.",
+ "QueryList": {
+ "description": "A list of queries to run on a cluster.",
"type": "object",
"properties": {
- "bootDiskSizeGb": {
- "description": "Optional Size in GB of the boot disk (default is 500GB).",
- "format": "int32",
- "type": "integer"
+ "queries": {
+ "description": "Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "QueryList"
+ },
+ "HadoopJob": {
+ "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
+ "type": "object",
+ "properties": {
+ "mainJarFileUri": {
+ "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
},
+ "jarFileUris": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "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"
+ },
+ "description": "Optional A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
+ "type": "object"
+ },
+ "args": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Optional The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission."
+ },
+ "fileUris": {
+ "description": "Optional HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainClass": {
+ "type": "string",
+ "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris."
+ },
+ "archiveUris": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip."
+ }
+ },
+ "id": "HadoopJob"
+ },
+ "DiagnoseClusterRequest": {
+ "type": "object",
+ "properties": {},
+ "id": "DiagnoseClusterRequest",
+ "description": "A request to collect cluster diagnostic information."
+ },
+ "DiskConfig": {
+ "type": "object",
+ "properties": {
"numLocalSsds": {
"description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
"format": "int32",
"type": "integer"
+ },
+ "bootDiskSizeGb": {
+ "description": "Optional Size in GB of the boot disk (default is 500GB).",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "DiskConfig"
+ "id": "DiskConfig",
+ "description": "Specifies the config of disk options for a group of VM instances."
},
"ClusterOperationMetadata": {
+ "type": "object",
"properties": {
- "operationType": {
- "description": "Output-only The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only Short description of operation.",
- "type": "string"
- },
"warnings": {
"description": "Output-only Errors encountered during operation execution.",
"type": "array",
@@ -1874,51 +1827,56 @@
"type": "object"
},
"status": {
- "description": "Output-only Current operation status.",
- "$ref": "ClusterOperationStatus"
+ "$ref": "ClusterOperationStatus",
+ "description": "Output-only Current operation status."
},
"statusHistory": {
- "description": "Output-only The previous operation status.",
"type": "array",
"items": {
"$ref": "ClusterOperationStatus"
- }
- },
- "clusterUuid": {
- "description": "Output-only Cluster UUID for the operation.",
- "type": "string"
+ },
+ "description": "Output-only The previous operation status."
},
"clusterName": {
"description": "Output-only Name of the cluster for the operation.",
"type": "string"
+ },
+ "clusterUuid": {
+ "type": "string",
+ "description": "Output-only Cluster UUID for the operation."
+ },
+ "operationType": {
+ "type": "string",
+ "description": "Output-only The operation type."
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
}
},
"id": "ClusterOperationMetadata",
- "description": "Metadata describing the operation.",
- "type": "object"
+ "description": "Metadata describing the operation."
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
},
"HiveJob": {
- "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
"continueOnFailure": {
"description": "Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
- "queryList": {
- "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"
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
},
"jarFileUris": {
"description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
@@ -1927,6 +1885,13 @@
"type": "string"
}
},
+ "scriptVariables": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";)."
+ },
"properties": {
"additionalProperties": {
"type": "string"
@@ -1935,15 +1900,11 @@
"type": "object"
}
},
- "id": "HiveJob"
- },
- "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"
+ "id": "HiveJob",
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN."
},
"DiagnoseClusterResults": {
+ "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.",
@@ -1951,13 +1912,50 @@
}
},
"id": "DiagnoseClusterResults",
- "description": "The location of diagnostic output.",
- "type": "object"
+ "description": "The location of diagnostic output."
+ },
+ "ClusterConfig": {
+ "description": "The cluster config.",
+ "type": "object",
+ "properties": {
+ "masterConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional The Google Compute Engine config settings for the master instance in a cluster."
+ },
+ "secondaryWorkerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional The Google Compute Engine config settings for additional worker instances in a cluster."
+ },
+ "initializationActions": {
+ "type": "array",
+ "items": {
+ "$ref": "NodeInitializationAction"
+ },
+ "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/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n"
+ },
+ "configBucket": {
+ "description": "Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.",
+ "type": "string"
+ },
+ "workerConfig": {
+ "$ref": "InstanceGroupConfig",
+ "description": "Optional The Google Compute Engine config settings for worker instances in a cluster."
+ },
+ "gceClusterConfig": {
+ "$ref": "GceClusterConfig",
+ "description": "Required The shared Google Compute Engine config settings for all instances in a cluster."
+ },
+ "softwareConfig": {
+ "$ref": "SoftwareConfig",
+ "description": "Optional The config settings for software inside the cluster."
+ }
+ },
+ "id": "ClusterConfig"
}
},
"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",
@@ -1979,8 +1977,10 @@
"ownerDomain": "google.com",
"name": "dataproc",
"batchPath": "batch",
- "revision": "20170228",
- "id": "dataproc:v1",
"documentationLink": "https://cloud.google.com/dataproc/",
- "title": "Google Cloud Dataproc API"
+ "id": "dataproc:v1",
+ "revision": "20170228",
+ "title": "Google Cloud Dataproc API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
diff --git a/dataproc/v1alpha1/dataproc-api.json b/dataproc/v1alpha1/dataproc-api.json
index 6da95ab..fff2896 100644
--- a/dataproc/v1alpha1/dataproc-api.json
+++ b/dataproc/v1alpha1/dataproc-api.json
@@ -1,147 +1,258 @@
{
- "batchPath": "batch",
- "revision": "20170228",
- "documentationLink": "https://cloud.google.com/dataproc/",
- "id": "dataproc:v1alpha1",
"title": "Google Cloud Dataproc API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"resources": {
- "operations": {
- "methods": {
- "cancel": {
- "flatPath": "v1alpha1/operations/{operationsId}:cancel",
- "id": "dataproc.operations.cancel",
- "path": "v1alpha1/{+name}:cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients may use Operations.GetOperation or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "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.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- }
- },
- "delete": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha1/operations/{operationsId}",
- "path": "v1alpha1/{+name}",
- "id": "dataproc.operations.delete",
- "description": "Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE"
- },
- "get": {
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "The operation resource name.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha1/operations/{operationsId}",
- "path": "v1alpha1/{+name}",
- "id": "dataproc.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service."
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The operation collection name.",
- "required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard List page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard List page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "type": "string",
- "location": "query",
- "description": "Required A JSON object that contains filters for the list operation, in the format {\"key1\":\"value1\",\"key2\":\"value2\", ..., }. Possible keys include project_id, cluster_name, and operation_state_matcher.If project_id is set, requests the list of operations that belong to the specified Google Cloud Platform project ID. This key is required.If cluster_name is set, requests the list of operations that were submitted to the specified cluster name. This key is optional.If operation_state_matcher is set, requests the list of operations that match one of the following status options: ALL, ACTIVE, or NON_ACTIVE."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/operations",
- "path": "v1alpha1/{+name}",
- "id": "dataproc.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED."
- }
- }
- },
"projects": {
"resources": {
"regions": {
"resources": {
+ "clusters": {
+ "methods": {
+ "patch": {
+ "description": "Request to update a cluster in a project.",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003e\"configuration.worker_configuration.num_instances,\"\u003c/code\u003e and the PATCH request body would specify the new value, as follows:\n{\n \"configuration\":{\n \"workerConfiguration\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003econfiguration.worker_configuration.num_instances\u003c/code\u003e is the only field that can be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.patch"
+ },
+ "get": {
+ "description": "Request to get the resource representation for a cluster in a project.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameters": {
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.get",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}"
+ },
+ "list": {
+ "id": "dataproc.projects.regions.clusters.list",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
+ "description": "Request a list of all regions/{region}/clusters in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "parameters": {
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "The standard List page size.",
+ "format": "int32"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard List page token.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters"
+ },
+ "create": {
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Request to create a cluster in a project.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "projectId",
+ "region"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
+ "id": "dataproc.projects.regions.clusters.create",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters"
+ },
+ "delete": {
+ "description": "Request to delete a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "clusterName"
+ ],
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "clusterName": {
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
+ "id": "dataproc.projects.regions.clusters.delete"
+ }
+ }
+ },
"jobs": {
"methods": {
- "cancel": {
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs:list or regions/{region}/jobs:get.",
- "request": {
- "$ref": "CancelJobRequest"
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit",
+ "id": "dataproc.projects.regions.jobs.submit",
+ "request": {
+ "$ref": "SubmitJobRequest"
+ },
+ "description": "Submits a job to a cluster."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
"parameterOrder": [
"projectId",
"region",
@@ -155,10 +266,10 @@
],
"parameters": {
"region": {
+ "description": "Required The Dataproc region in which to handle the request.",
"required": true,
"type": "string",
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request."
+ "location": "path"
},
"projectId": {
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -173,168 +284,19 @@
"location": "path"
}
},
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.regions.jobs.cancel",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
- },
- "get": {
- "description": "Gets the resource representation for a job in a project.",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "region": {
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The job ID."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.delete",
"path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.get"
- },
- "patch": {
- "request": {
- "$ref": "Job"
- },
- "description": "Updates a job in a project.",
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "response": {
- "$ref": "Job"
- },
- "parameters": {
- "region": {
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The job ID."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "id": "dataproc.projects.regions.jobs.patch",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}"
- },
- "submit": {
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit",
- "id": "dataproc.projects.regions.jobs.submit",
- "description": "Submits a job to a cluster.",
- "request": {
- "$ref": "SubmitJobRequest"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:submit"
- },
- "delete": {
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "jobId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
- "required": true,
- "type": "string"
- },
- "jobId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The job ID."
- },
- "region": {
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
- "path": "v1alpha1/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": {
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
+ "id": "dataproc.projects.regions.jobs.list",
+ "request": {
+ "$ref": "ListJobsRequest"
+ },
+ "description": "Lists regions/{region}/jobs in a project.",
"response": {
"$ref": "ListJobsResponse"
},
@@ -343,112 +305,57 @@
"region"
],
"httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"region": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The Dataproc region in which to handle the request."
- },
- "projectId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the job belongs to."
- }
- },
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs:list",
- "id": "dataproc.projects.regions.jobs.list",
- "description": "Lists regions/{region}/jobs in a project.",
- "request": {
- "$ref": "ListJobsRequest"
- }
- }
- }
- },
- "clusters": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "projectId",
- "region",
- "clusterName"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "region": {
- "location": "path",
"description": "Required The Dataproc region in which to handle the request.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.delete",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Request to delete a cluster in a project."
+ ]
},
- "patch": {
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.patch",
+ "cancel": {
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.regions.jobs.cancel",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"request": {
- "$ref": "Cluster"
+ "$ref": "CancelJobRequest"
},
- "description": "Request to update a cluster in a project.",
- "response": {
- "$ref": "Operation"
- },
+ "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",
- "clusterName"
+ "jobId"
],
- "httpMethod": "PATCH",
+ "response": {
+ "$ref": "Job"
+ },
"parameters": {
"projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
- "required": true,
- "type": "string"
- },
- "region": {
- "description": "Required The Dataproc region in which to handle the request.",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
"type": "string",
"location": "path"
},
- "updateMask": {
- "type": "string",
- "location": "query",
- "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003e\"configuration.worker_configuration.num_instances,\"\u003c/code\u003e and the PATCH request body would specify the new value, as follows:\n{\n \"configuration\":{\n \"workerConfiguration\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003econfiguration.worker_configuration.num_instances\u003c/code\u003e is the only field that can be updated.",
- "format": "google-fieldmask"
- },
- "clusterName": {
+ "jobId": {
"location": "path",
- "description": "Required The cluster name.",
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
"required": true,
"type": "string"
}
@@ -457,133 +364,232 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
- "get": {
- "parameters": {
- "region": {
- "description": "Required The Dataproc region in which to handle the request.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- }
+ "patch": {
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.patch",
+ "request": {
+ "$ref": "Job"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "id": "dataproc.projects.regions.clusters.get",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
- "description": "Request to get the resource representation for a cluster in a project.",
- "httpMethod": "GET",
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
"parameterOrder": [
"projectId",
"region",
- "clusterName"
+ "jobId"
],
- "response": {
- "$ref": "Cluster"
- }
- },
- "list": {
- "id": "dataproc.projects.regions.clusters.list",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
- "description": "Request a list of all regions/{region}/clusters in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
+ "httpMethod": "PATCH",
"parameters": {
- "pageToken": {
- "description": "The standard List page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "The standard List page size.",
- "format": "int32"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- },
"region": {
"location": "path",
"description": "Required The Dataproc region in which to handle the request.",
"required": true,
"type": "string"
},
- "filter": {
- "type": "string",
+ "updateMask": {
"location": "query",
- "description": "Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "region"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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.",
- "required": true,
+ "description": "Required Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
+ "format": "google-fieldmask",
"type": "string"
},
- "region": {
- "description": "Required The Dataproc region in which to handle the request.",
+ "projectId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to."
+ },
+ "jobId": {
+ "description": "Required The job ID.",
"required": true,
"type": "string",
"location": "path"
}
},
- "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
- "id": "dataproc.projects.regions.clusters.create",
- "path": "v1alpha1/projects/{projectId}/regions/{region}/clusters",
- "description": "Request to create a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}"
+ },
+ "get": {
+ "response": {
+ "$ref": "Job"
+ },
+ "parameterOrder": [
+ "projectId",
+ "region",
+ "jobId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "Required The job ID.",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "location": "path",
+ "description": "Required The Dataproc region in which to handle the request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "path": "v1alpha1/projects/{projectId}/regions/{region}/jobs/{jobId}",
+ "id": "dataproc.projects.regions.jobs.get",
+ "description": "Gets the resource representation for a job in a project."
}
}
}
}
}
}
+ },
+ "operations": {
+ "methods": {
+ "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. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients may use Operations.GetOperation or other methods to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/operations/{operationsId}:cancel",
+ "path": "v1alpha1/{+name}:cancel",
+ "id": "dataproc.operations.cancel"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1alpha1/operations/{operationsId}",
+ "id": "dataproc.operations.delete",
+ "path": "v1alpha1/{+name}",
+ "description": "Deletes a long-running operation. It indicates the client is no longer interested in the operation result. It does not cancel the operation."
+ },
+ "get": {
+ "flatPath": "v1alpha1/operations/{operationsId}",
+ "id": "dataproc.operations.get",
+ "path": "v1alpha1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients may use this method to poll the operation result at intervals as recommended by the API service.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The operation resource name.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations/.+$",
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "Required A JSON object that contains filters for the list operation, in the format {\"key1\":\"value1\",\"key2\":\"value2\", ..., }. Possible keys include project_id, cluster_name, and operation_state_matcher.If project_id is set, requests the list of operations that belong to the specified Google Cloud Platform project ID. This key is required.If cluster_name is set, requests the list of operations that were submitted to the specified cluster name. This key is optional.If operation_state_matcher is set, requests the list of operations that match one of the following status options: ALL, ACTIVE, or NON_ACTIVE.",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The operation collection name.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard List page size.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1alpha1/operations",
+ "id": "dataproc.operations.list",
+ "path": "v1alpha1/{+name}"
+ }
+ }
}
},
"parameters": {
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -596,21 +602,17 @@
"default": "true"
},
"uploadType": {
+ "location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -620,10 +622,16 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -635,43 +643,79 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
},
"quotaUser": {
- "type": "string",
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
+ "GceClusterConfiguration": {
+ "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The Google Compute Engine metadata entries to add to all instances.",
+ "type": "object"
+ },
+ "internalIpOnly": {
+ "description": "If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
+ },
+ "serviceAccountScopes": {
+ "description": "The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example \"auth.googleapis.com/compute\" and \"auth.googleapis.com/devstorage.full_control\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "tags": {
+ "description": "The Google Compute Engine tags to add to all instances.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "serviceAccount": {
+ "description": "Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
+ "type": "string"
+ },
+ "subnetworkUri": {
+ "description": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.",
+ "type": "string"
+ },
+ "networkUri": {
+ "description": "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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Required The zone where the Google Compute Engine cluster will be located. Example: \"compute.googleapis.com/projects/project_id /zones/us-east1-a\".",
+ "type": "string"
+ }
+ },
+ "id": "GceClusterConfiguration"
+ },
"CancelOperationRequest": {
"description": "The request message for Operations.CancelOperation.",
"type": "object",
@@ -679,7 +723,6 @@
"id": "CancelOperationRequest"
},
"DiagnoseClusterOutputLocation": {
- "id": "DiagnoseClusterOutputLocation",
"description": "The location where output from diagnostic command can be found.",
"type": "object",
"properties": {
@@ -687,20 +730,13 @@
"description": "Output-only The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics.",
"type": "string"
}
- }
+ },
+ "id": "DiagnoseClusterOutputLocation"
},
"Operation": {
"description": "An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.",
"type": "object",
"properties": {
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and \"Response\". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.",
- "type": "object"
- },
"name": {
"description": "The name of the operation resource, in the format projects/project_id/operations/operation_id",
"type": "string"
@@ -711,8 +747,8 @@
},
"metadata": {
"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 associated with the operation.",
"type": "object"
@@ -720,6 +756,14 @@
"done": {
"description": "Indicates if the operation is done. If true, the operation is complete and the result is available. If false, the operation is still in progress.",
"type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The operation response. If the called method returns no data on success, the response is google.protobuf.Empty. If the called method is Get,Create or Update, the response is the resource. For all other methods, the response type is a concatenation of the method name and \"Response\". For example, if the called method is TakeSnapshot(), the response type is TakeSnapshotResponse.",
+ "type": "object"
}
},
"id": "Operation"
@@ -735,6 +779,7 @@
"type": "string"
},
"state": {
+ "description": "A message containing the operation state.",
"type": "string",
"enumDescriptions": [
"Unused.",
@@ -747,8 +792,7 @@
"PENDING",
"RUNNING",
"DONE"
- ],
- "description": "A message containing the operation state."
+ ]
},
"details": {
"description": "A message containing any operation metadata details.",
@@ -776,7 +820,6 @@
"id": "JobReference"
},
"SubmitJobRequest": {
- "type": "object",
"properties": {
"job": {
"$ref": "Job",
@@ -784,21 +827,20 @@
}
},
"id": "SubmitJobRequest",
- "description": "A job submission request."
+ "description": "A job submission 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 which 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 purpose.\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 will be a common set of message types for APIs to use.",
"type": "array",
"items": {
+ "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- },
- "type": "object"
+ }
}
},
"code": {
@@ -811,9 +853,13 @@
"type": "string"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc which 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 purpose.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object"
},
"JobScheduling": {
+ "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": {
"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.",
@@ -821,28 +867,9 @@
"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"
- },
- "NodeInitializationAction": {
- "properties": {
- "executableFile": {
- "description": "Required Google Cloud Storage URI of executable file.",
- "type": "string"
- },
- "executionTimeout": {
- "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction",
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
- "type": "object"
+ "id": "JobScheduling"
},
"ListJobsResponse": {
- "id": "ListJobsResponse",
"description": "A response to a request to list jobs in a project.",
"type": "object",
"properties": {
@@ -857,6 +884,23 @@
"$ref": "Job"
}
}
+ },
+ "id": "ListJobsResponse"
+ },
+ "NodeInitializationAction": {
+ "id": "NodeInitializationAction",
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "type": "object",
+ "properties": {
+ "executionTimeout": {
+ "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "executableFile": {
+ "description": "Required Google Cloud Storage URI of executable file.",
+ "type": "string"
+ }
}
},
"CancelJobRequest": {
@@ -870,19 +914,12 @@
"type": "object",
"properties": {
"queryFileUri": {
- "description": "The HCFS URI of the script that contains SQL queries.",
- "type": "string"
+ "type": "string",
+ "description": "The HCFS URI of the script that contains SQL queries."
},
"queryList": {
- "$ref": "QueryList",
- "description": "A list of queries."
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "description": "A list of queries.",
+ "$ref": "QueryList"
},
"scriptVariables": {
"additionalProperties": {
@@ -891,16 +928,23 @@
"description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
"type": "object"
},
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"loggingConfiguration": {
"$ref": "LoggingConfiguration",
"description": "Optional The runtime log configuration for job execution."
},
"properties": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
+ "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."
}
},
"id": "SparkSqlJob"
@@ -909,6 +953,10 @@
"description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
"type": "object",
"properties": {
+ "configuration": {
+ "description": "Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.",
+ "$ref": "ClusterConfiguration"
+ },
"createTime": {
"description": "Output-only The timestamp of cluster creation.",
"format": "google-datetime",
@@ -922,23 +970,23 @@
}
},
"metrics": {
- "$ref": "ClusterMetrics",
- "description": "Contains cluster daemon metrics such as HDFS and YARN stats."
+ "description": "Contains cluster daemon metrics such as HDFS and YARN stats.",
+ "$ref": "ClusterMetrics"
},
"status": {
"description": "Output-only Cluster status.",
"$ref": "ClusterStatus"
},
"statusHistory": {
+ "description": "Output-only Previous cluster statuses.",
"type": "array",
"items": {
"$ref": "ClusterStatus"
- },
- "description": "Output-only Previous cluster statuses."
+ }
},
"clusterName": {
- "type": "string",
- "description": "Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused."
+ "description": "Required The cluster name. Cluster names within a project must be unique. Names from 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.",
@@ -947,10 +995,6 @@
"projectId": {
"description": "Required The Google Cloud Platform project ID that the cluster belongs to.",
"type": "string"
- },
- "configuration": {
- "description": "Required The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.",
- "$ref": "ClusterConfiguration"
}
},
"id": "Cluster"
@@ -959,16 +1003,16 @@
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
"operations": {
+ "description": "A list of operations that match the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
- },
- "description": "A list of operations that match the specified filter in the request."
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
"id": "ListOperationsResponse"
@@ -977,14 +1021,46 @@
"description": "Metadata describing the operation.",
"type": "object",
"properties": {
- "clusterName": {
- "description": "Name of the cluster for the operation.",
+ "operationType": {
+ "description": "Output-only The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Output-only Current operation status.",
+ "$ref": "OperationStatus"
+ },
+ "state": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is currently running.",
+ "The operation is done, either cancelled or completed."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PENDING",
+ "RUNNING",
+ "DONE"
+ ],
+ "description": "A message containing the operation state."
+ },
+ "details": {
+ "description": "A message containing any operation metadata details.",
"type": "string"
},
"clusterUuid": {
"description": "Cluster UUId for the operation.",
"type": "string"
},
+ "clusterName": {
+ "description": "Name of the cluster for the operation.",
+ "type": "string"
+ },
"innerState": {
"description": "A message containing the detailed operation state.",
"type": "string"
@@ -1017,43 +1093,12 @@
"items": {
"$ref": "OperationStatus"
}
- },
- "operationType": {
- "description": "Output-only The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only Short description of operation.",
- "type": "string"
- },
- "status": {
- "$ref": "OperationStatus",
- "description": "Output-only Current operation status."
- },
- "details": {
- "description": "A message containing any operation metadata details.",
- "type": "string"
- },
- "state": {
- "description": "A message containing the operation state.",
- "type": "string",
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is currently running.",
- "The operation is done, either cancelled or completed."
- ],
- "enum": [
- "UNKNOWN",
- "PENDING",
- "RUNNING",
- "DONE"
- ]
}
},
"id": "OperationMetadata"
},
"JobPlacement": {
+ "description": "Cloud Dataproc job configuration.",
"type": "object",
"properties": {
"clusterName": {
@@ -1065,8 +1110,7 @@
"type": "string"
}
},
- "id": "JobPlacement",
- "description": "Cloud Dataproc job configuration."
+ "id": "JobPlacement"
},
"ClusterStatus": {
"description": "The status of a cluster and its instances.",
@@ -1082,8 +1126,6 @@
"type": "string"
},
"state": {
- "description": "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.",
@@ -1099,15 +1141,23 @@
"ERROR",
"DELETING",
"UPDATING"
- ]
+ ],
+ "description": "The cluster's state.",
+ "type": "string"
}
},
"id": "ClusterStatus"
},
"PigJob": {
- "description": "A Cloud Dataproc job for running Pig queries on YARN.",
- "type": "object",
"properties": {
+ "queryFileUri": {
+ "description": "The HCFS URI of the script that contains the Pig queries.",
+ "type": "string"
+ },
+ "queryList": {
+ "$ref": "QueryList",
+ "description": "A list of queries."
+ },
"jarFileUris": {
"description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
"type": "array",
@@ -1116,37 +1166,31 @@
}
},
"scriptVariables": {
- "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: \"name=value\").",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: \"name=value\").",
+ "type": "object"
},
"loggingConfiguration": {
"description": "Optional The runtime log configuration for job execution.",
"$ref": "LoggingConfiguration"
},
"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."
},
"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"
}
},
- "id": "PigJob"
+ "id": "PigJob",
+ "description": "A Cloud Dataproc job for running Pig queries on YARN.",
+ "type": "object"
},
"AcceleratorConfiguration": {
"description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
@@ -1164,27 +1208,7 @@
},
"id": "AcceleratorConfiguration"
},
- "ListClustersResponse": {
- "description": "The list of all clusters in a project.",
- "type": "object",
- "properties": {
- "clusters": {
- "type": "array",
- "items": {
- "$ref": "Cluster"
- },
- "description": "Output-only The clusters in the project."
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListClustersResponse"
- },
"ManagedGroupConfiguration": {
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object",
"properties": {
"instanceGroupManagerName": {
"description": "Output-only The name of Instance Group Manager managing this group.",
@@ -1195,38 +1219,82 @@
"type": "string"
}
},
- "id": "ManagedGroupConfiguration"
+ "id": "ManagedGroupConfiguration",
+ "description": "Specifies the resources used to actively manage an instance group.",
+ "type": "object"
+ },
+ "ListClustersResponse": {
+ "description": "The list of all clusters in a project.",
+ "type": "object",
+ "properties": {
+ "clusters": {
+ "description": "Output-only The clusters in the project.",
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "ListClustersResponse"
},
"Job": {
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
+ "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"
+ },
+ "submittedBy": {
+ "description": "Output-only The email address of the user submitting the job. For jobs submitted on the cluster, the address is \u003ccode\u003eusername@hostname\u003c/code\u003e.",
+ "type": "string"
+ },
"scheduling": {
- "$ref": "JobScheduling",
- "description": "Optional Job scheduling configuration."
+ "description": "Optional Job scheduling configuration.",
+ "$ref": "JobScheduling"
},
"pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
+ "description": "Job is a Pig job.",
+ "$ref": "PigJob"
},
"driverOutputUri": {
"description": "Output-only A URI pointing to the location of the mixed stdout/stderr of the job's driver program—for example, \u003ccode\u003egs://sysbucket123/foo-cluster/jobid-123/driver/output\u003c/code\u003e.",
"type": "string"
},
"hiveJob": {
- "description": "Job is a Hive job.",
- "$ref": "HiveJob"
+ "$ref": "HiveJob",
+ "description": "Job is a Hive job."
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
- "type": "object"
+ "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."
},
"driverOutputResourceUri": {
- "type": "string",
- "description": "Output-only A URI pointing to the location of the stdout of the job's driver program."
+ "description": "Output-only A URI pointing to the location of the stdout of the job's driver program.",
+ "type": "string"
+ },
+ "sparkJob": {
+ "description": "Job is a Spark job.",
+ "$ref": "SparkJob"
+ },
+ "sparkSqlJob": {
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
},
"statusHistory": {
"description": "Output-only The previous job status.",
@@ -1235,20 +1303,12 @@
"$ref": "JobStatus"
}
},
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "$ref": "SparkJob",
- "description": "Job is a Spark job."
- },
"yarnApplications": {
+ "description": "Output-only The collection of Yarn applications spun up by this job.",
"type": "array",
"items": {
"$ref": "YarnApplication"
- },
- "description": "Output-only The collection of Yarn applications spun up by this job."
+ }
},
"pysparkJob": {
"$ref": "PySparkJob",
@@ -1267,24 +1327,8 @@
"type": "string"
},
"hadoopJob": {
- "description": "Job is a Hadoop job.",
- "$ref": "HadoopJob"
- },
- "status": {
- "$ref": "JobStatus",
- "description": "Output-only The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
- },
- "placement": {
- "description": "Required Job information, including how, when, and where to run the job.",
- "$ref": "JobPlacement"
- },
- "driverControlFilesUri": {
- "description": "Output-only If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
- "type": "string"
- },
- "submittedBy": {
- "description": "Output-only The email address of the user submitting the job. For jobs submitted on the cluster, the address is \u003ccode\u003eusername@hostname\u003c/code\u003e.",
- "type": "string"
+ "$ref": "HadoopJob",
+ "description": "Job is a Hadoop job."
}
},
"id": "Job"
@@ -1293,27 +1337,16 @@
"description": "A Cloud Dataproc job for running Spark applications on YARN.",
"type": "object",
"properties": {
- "mainJarFileUri": {
- "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"loggingConfiguration": {
- "$ref": "LoggingConfiguration",
- "description": "Optional The runtime log configuration for job execution."
+ "description": "Optional The runtime log configuration for job execution.",
+ "$ref": "LoggingConfiguration"
},
"properties": {
+ "description": "Optional A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
+ }
},
"args": {
"description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
@@ -1323,11 +1356,11 @@
}
},
"fileUris": {
- "description": "Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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.",
@@ -1339,6 +1372,17 @@
"items": {
"type": "string"
}
+ },
+ "mainJarFileUri": {
+ "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.",
+ "type": "string"
+ },
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "SparkJob"
@@ -1347,16 +1391,6 @@
"description": "Cloud Dataproc job status.",
"type": "object",
"properties": {
- "stateStartTime": {
- "description": "Output-only The time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "endTime": {
- "type": "string",
- "description": "The time when the job completed.",
- "format": "google-datetime"
- },
"startTime": {
"description": "The time when the server started the job.",
"format": "google-datetime",
@@ -1368,6 +1402,8 @@
"format": "google-datetime"
},
"state": {
+ "description": "Required 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.",
@@ -1391,13 +1427,21 @@
"DONE",
"ERROR",
"ATTEMPT_FAILURE"
- ],
- "description": "Required A state message specifying the overall job state.",
- "type": "string"
+ ]
},
"details": {
"description": "Optional Job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
"type": "string"
+ },
+ "stateStartTime": {
+ "description": "Output-only The time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time when the job completed.",
+ "format": "google-datetime",
+ "type": "string"
}
},
"id": "JobStatus"
@@ -1420,20 +1464,10 @@
"id": "DiskConfiguration"
},
"ClusterOperationStatus": {
+ "description": "The status of the operation.",
"type": "object",
"properties": {
- "stateStartTime": {
- "description": "Output-only The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
"state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
"enum": [
"UNKNOWN",
"PENDING",
@@ -1441,7 +1475,13 @@
"DONE"
],
"description": "Output-only A message containing the operation state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
},
"details": {
"description": "Output-onlyA message containing any operation metadata details.",
@@ -1450,25 +1490,20 @@
"innerState": {
"description": "Output-only A message containing the detailed operation state.",
"type": "string"
+ },
+ "stateStartTime": {
+ "type": "string",
+ "description": "Output-only The time this state was entered.",
+ "format": "google-datetime"
}
},
- "id": "ClusterOperationStatus",
- "description": "The status of the operation."
+ "id": "ClusterOperationStatus"
},
"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.",
+ "type": "object",
"properties": {
"state": {
- "enum": [
- "STATE_UNSPECIFIED",
- "NEW",
- "NEW_SAVING",
- "SUBMITTED",
- "ACCEPTED",
- "RUNNING",
- "FINISHED",
- "FAILED",
- "KILLED"
- ],
"description": "Required The application state.",
"type": "string",
"enumDescriptions": [
@@ -1481,6 +1516,17 @@
"Status is FINISHED.",
"Status is FAILED.",
"Status is KILLED."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "NEW",
+ "NEW_SAVING",
+ "SUBMITTED",
+ "ACCEPTED",
+ "RUNNING",
+ "FINISHED",
+ "FAILED",
+ "KILLED"
]
},
"name": {
@@ -1497,11 +1543,11 @@
"type": "number"
}
},
- "id": "YarnApplication",
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.",
- "type": "object"
+ "id": "YarnApplication"
},
"QueryList": {
+ "description": "A list of queries to run on a cluster.",
+ "type": "object",
"properties": {
"queries": {
"type": "array",
@@ -1511,19 +1557,12 @@
"description": "Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n"
}
},
- "id": "QueryList",
- "description": "A list of queries to run on a cluster.",
- "type": "object"
+ "id": "QueryList"
},
"HadoopJob": {
+ "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
+ "type": "object",
"properties": {
- "jarFileUris": {
- "description": "Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"loggingConfiguration": {
"$ref": "LoggingConfiguration",
"description": "Optional The runtime log configuration for job execution."
@@ -1550,8 +1589,8 @@
}
},
"mainClass": {
- "type": "string",
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris."
+ "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
},
"archiveUris": {
"description": "Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
@@ -1563,22 +1602,36 @@
"mainJarFileUri": {
"description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar hdfs:/tmp/test-samples/custom-wordcount.jar file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar",
"type": "string"
- }
- },
- "id": "HadoopJob",
- "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
- "type": "object"
- },
- "ClusterOperationMetadata": {
- "description": "Metadata describing the operation.",
- "type": "object",
- "properties": {
- "warnings": {
- "description": "Output-only Errors encountered during operation execution.",
+ },
+ "jarFileUris": {
+ "description": "Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"type": "array",
"items": {
"type": "string"
}
+ }
+ },
+ "id": "HadoopJob"
+ },
+ "ClusterOperationMetadata": {
+ "id": "ClusterOperationMetadata",
+ "description": "Metadata describing the operation.",
+ "type": "object",
+ "properties": {
+ "operationType": {
+ "description": "Output-only The operation type.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Output-only Short description of operation.",
+ "type": "string"
+ },
+ "warnings": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Output-only Errors encountered during operation execution."
},
"labels": {
"additionalProperties": {
@@ -1598,108 +1651,61 @@
"$ref": "ClusterOperationStatus"
}
},
- "clusterUuid": {
- "description": "Output-only Cluster UUID for the operation.",
- "type": "string"
- },
"clusterName": {
"description": "Output-only Name of the cluster for the operation.",
"type": "string"
},
- "operationType": {
- "description": "Output-only The operation type.",
- "type": "string"
- },
- "description": {
- "description": "Output-only Short description of operation.",
+ "clusterUuid": {
+ "description": "Output-only Cluster UUID for the operation.",
"type": "string"
}
- },
- "id": "ClusterOperationMetadata"
- },
- "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"
+ }
},
"HiveJob": {
- "description": "A Cloud Dataproc job for running Hive 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"
},
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
+ },
"jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"type": "array",
"items": {
"type": "string"
- },
- "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."
+ }
},
"scriptVariables": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name=\"value\";')."
+ "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: 'SET name=\"value\";').",
+ "type": "object"
},
"properties": {
- "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code."
+ "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"
+ "id": "HiveJob",
+ "description": "A Cloud Dataproc job for running Hive queries on YARN.",
+ "type": "object"
},
- "ListJobsRequest": {
- "description": "A request to list jobs in a project.",
+ "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": {
- "jobStateMatcher": {
- "description": "Optional Specifies enumerated categories of jobs to list.",
- "type": "string",
- "enumDescriptions": [
- "Match all jobs, regardless of state.",
- "Only match jobs in non-terminal states: PENDING, RUNNING, CANCEL_PENDING",
- "Only match jobs in terminal states: CANCELLED, DONE, ERROR"
- ],
- "enum": [
- "ALL",
- "ACTIVE",
- "NON_ACTIVE"
- ]
- },
- "pageToken": {
- "description": "Optional The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "clusterName": {
- "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional The number of results to return in each response.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "Optional A filter constraining which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)",
- "type": "string"
- }
- },
- "id": "ListJobsRequest"
+ "properties": {},
+ "id": "Empty"
},
"DiagnoseClusterResults": {
"description": "The location of diagnostic output.",
@@ -1712,9 +1718,46 @@
},
"id": "DiagnoseClusterResults"
},
- "GceConfiguration": {
+ "ListJobsRequest": {
+ "id": "ListJobsRequest",
+ "description": "A request to list jobs in a project.",
"type": "object",
"properties": {
+ "pageSize": {
+ "description": "Optional The number of results to return in each response.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "type": "string",
+ "description": "Optional A filter constraining which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)"
+ },
+ "jobStateMatcher": {
+ "enumDescriptions": [
+ "Match all jobs, regardless of state.",
+ "Only match jobs in non-terminal states: PENDING, RUNNING, CANCEL_PENDING",
+ "Only match jobs in terminal states: CANCELLED, DONE, ERROR"
+ ],
+ "enum": [
+ "ALL",
+ "ACTIVE",
+ "NON_ACTIVE"
+ ],
+ "description": "Optional Specifies enumerated categories of jobs to list.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Optional The page token, returned by a previous call, to request the next page of results.",
+ "type": "string"
+ },
+ "clusterName": {
+ "type": "string",
+ "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster."
+ }
+ }
+ },
+ "GceConfiguration": {
+ "properties": {
"imageUri": {
"description": "Deprecated The Google Compute Engine image resource used for cluster instances. Example: \"compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904\".",
"type": "string"
@@ -1740,7 +1783,8 @@
}
},
"id": "GceConfiguration",
- "description": "Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster."
+ "description": "Deprecated Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
+ "type": "object"
},
"SoftwareConfiguration": {
"description": "Specifies the selection and configuration of software inside the cluster.",
@@ -1751,42 +1795,17 @@
"type": "string"
},
"properties": {
+ "description": "Optional The properties to set on daemon configuration files.Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf",
+ "type": "object",
"additionalProperties": {
"type": "string"
- },
- "description": "Optional The properties to set on daemon configuration files.Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf",
- "type": "object"
+ }
}
},
"id": "SoftwareConfiguration"
},
"PySparkJob": {
"properties": {
- "jarFileUris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks."
- },
- "loggingConfiguration": {
- "$ref": "LoggingConfiguration",
- "description": "Optional The runtime log configuration 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"
- },
- "args": {
- "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"fileUris": {
"description": "Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.",
"type": "array",
@@ -1795,18 +1814,43 @@
}
},
"pythonFileUris": {
- "description": "Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Optional HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip."
+ },
+ "mainPythonFileUri": {
+ "type": "string",
+ "description": "Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file."
+ },
+ "archiveUris": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip."
+ },
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
"type": "array",
"items": {
"type": "string"
}
},
- "mainPythonFileUri": {
- "description": "Required The Hadoop Compatible Filesystem (HCFS) URI of the main Python file to use as the driver. Must be a .py file.",
- "type": "string"
+ "loggingConfiguration": {
+ "$ref": "LoggingConfiguration",
+ "description": "Optional The runtime log configuration for job execution."
},
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "properties": {
+ "description": "Optional A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "args": {
+ "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"type": "array",
"items": {
"type": "string"
@@ -1818,11 +1862,10 @@
"type": "object"
},
"LoggingConfiguration": {
- "description": "The runtime logging configuration of the job.",
- "type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
+ "type": "string",
"enum": [
"LEVEL_UNSPECIFIED",
"ALL",
@@ -1833,19 +1876,24 @@
"ERROR",
"FATAL",
"OFF"
- ],
- "type": "string"
+ ]
},
"description": "The per-package log levels for the driver. This may include 'root' package name to configure rootLogger. Examples: com.google = FATAL, root = INFO, org.apache = DEBUG",
"type": "object"
}
},
- "id": "LoggingConfiguration"
+ "id": "LoggingConfiguration",
+ "description": "The runtime logging configuration of the job.",
+ "type": "object"
},
"ClusterConfiguration": {
"description": "The cluster configuration.",
"type": "object",
"properties": {
+ "masterConfiguration": {
+ "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfiguration"
+ },
"secondaryWorkerConfiguration": {
"$ref": "InstanceGroupConfiguration",
"description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster."
@@ -1873,12 +1921,12 @@
"$ref": "InstanceGroupConfiguration"
},
"softwareConfiguration": {
- "description": "Optional The configuration settings for software inside the cluster.",
- "$ref": "SoftwareConfiguration"
+ "$ref": "SoftwareConfiguration",
+ "description": "Optional The configuration settings for software inside the cluster."
},
"gceClusterConfiguration": {
- "description": "Optional The shared Google Compute Engine configuration settings for all instances in a cluster.",
- "$ref": "GceClusterConfiguration"
+ "$ref": "GceClusterConfiguration",
+ "description": "Optional The shared Google Compute Engine configuration settings for all instances in a cluster."
},
"configurationBucket": {
"description": "Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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, then it will create and manage this project-level, per-location bucket for you.",
@@ -1894,21 +1942,19 @@
"description": "Deprecated The configuration settings of master node disk options."
},
"workerDiskConfiguration": {
- "description": "Deprecated The configuration settings of worker node disk options.",
- "$ref": "DiskConfiguration"
+ "$ref": "DiskConfiguration",
+ "description": "Deprecated The configuration settings of worker node disk options."
},
"gceConfiguration": {
- "$ref": "GceConfiguration",
- "description": "Deprecated The Google Compute Engine configuration settings for cluster resources."
- },
- "masterConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster."
+ "description": "Deprecated The Google Compute Engine configuration settings for cluster resources.",
+ "$ref": "GceConfiguration"
}
},
"id": "ClusterConfiguration"
},
"ClusterMetrics": {
+ "id": "ClusterMetrics",
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
"type": "object",
"properties": {
"hdfsMetrics": {
@@ -1921,31 +1967,34 @@
},
"yarnMetrics": {
"additionalProperties": {
- "format": "int64",
- "type": "string"
+ "type": "string",
+ "format": "int64"
},
"description": "The YARN metrics.",
"type": "object"
}
- },
- "id": "ClusterMetrics",
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats."
+ }
},
"InstanceGroupConfiguration": {
+ "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
"type": "object",
"properties": {
+ "diskConfiguration": {
+ "$ref": "DiskConfiguration",
+ "description": "Disk option configuration settings."
+ },
"machineTypeUri": {
+ "description": "The Google Compute Engine machine type used for cluster instances. Example: \"compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2\".",
+ "type": "string"
+ },
+ "imageUri": {
"type": "string",
- "description": "The Google Compute Engine machine type used for cluster instances. Example: \"compute.googleapis.com/projects/project_id /zones/us-east1-a/machineTypes/n1-standard-2\"."
+ "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: \"compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904\"."
},
"isPreemptible": {
"description": "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 SoftwareConfiguration.image_version. Example: \"compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904\".",
- "type": "string"
- },
"managedGroupConfiguration": {
"description": "Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
"$ref": "ManagedGroupConfiguration"
@@ -1968,69 +2017,16 @@
"description": "The number of VM instances in the instance group. For master instance groups, must be set to 1.",
"format": "int32",
"type": "integer"
- },
- "diskConfiguration": {
- "description": "Disk option configuration settings.",
- "$ref": "DiskConfiguration"
}
},
- "id": "InstanceGroupConfiguration",
- "description": "The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group."
- },
- "GceClusterConfiguration": {
- "description": "Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
- "type": "object",
- "properties": {
- "serviceAccountScopes": {
- "description": "The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example \"auth.googleapis.com/compute\" and \"auth.googleapis.com/devstorage.full_control\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "tags": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The Google Compute Engine tags to add to all instances."
- },
- "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": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0.",
- "type": "string"
- },
- "networkUri": {
- "description": "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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: compute.googleapis.com/projects/[project_id]/regions/global/default.",
- "type": "string"
- },
- "zoneUri": {
- "description": "Required The zone where the Google Compute Engine cluster will be located. Example: \"compute.googleapis.com/projects/project_id /zones/us-east1-a\".",
- "type": "string"
- },
- "internalIpOnly": {
- "description": "If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The Google Compute Engine metadata entries to add to all instances.",
- "type": "object"
- }
- },
- "id": "GceClusterConfiguration"
+ "id": "InstanceGroupConfiguration"
}
},
- "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": "v1alpha1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -2042,11 +2038,15 @@
}
}
},
- "servicePath": "",
- "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"kind": "discovery#restDescription",
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+ "servicePath": "",
"rootUrl": "https://dataproc.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "dataproc"
+ "name": "dataproc",
+ "batchPath": "batch",
+ "id": "dataproc:v1alpha1",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "revision": "20170228"
}
diff --git a/dataproc/v1beta1/dataproc-api.json b/dataproc/v1beta1/dataproc-api.json
index db1a85c..b89b9a6 100644
--- a/dataproc/v1beta1/dataproc-api.json
+++ b/dataproc/v1beta1/dataproc-api.json
@@ -1,21 +1,18 @@
{
- "documentationLink": "https://cloud.google.com/dataproc/",
- "revision": "20170228",
- "id": "dataproc:v1beta1",
- "title": "Google Cloud Dataproc API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
"resources": {
"operations": {
"methods": {
"cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
@@ -25,21 +22,15 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/operations/{operationsId}:cancel",
- "id": "dataproc.operations.cancel",
"path": "v1beta1/{+name}:cancel",
+ "id": "dataproc.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.get or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
"request": {
"$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use operations.get or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation."
+ }
},
"delete": {
- "id": "dataproc.operations.delete",
- "path": "v1beta1/{+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.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
@@ -59,16 +50,25 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/operations/{operationsId}"
+ "flatPath": "v1beta1/operations/{operationsId}",
+ "id": "dataproc.operations.delete",
+ "path": "v1beta1/{+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": "v1beta1/{+name}",
+ "id": "dataproc.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "response": {
+ "$ref": "Operation"
+ },
"parameterOrder": [
"name"
],
"httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
"pattern": "^operations/.+$",
@@ -78,287 +78,79 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "dataproc.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."
+ "flatPath": "v1beta1/operations/{operationsId}"
},
"list": {
"path": "v1beta1/{+name}",
"id": "dataproc.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 below allows API services to override the binding to use different resource name schemes, such as users/*/operations.",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
"parameterOrder": [
"name"
],
"httpMethod": "GET",
- "response": {
- "$ref": "ListOperationsResponse"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
"name": {
+ "pattern": "^operations$",
+ "location": "path",
"description": "The name of the operation collection.",
"required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path"
+ "type": "string"
},
"pageToken": {
- "location": "query",
"description": "The standard list page token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/operations"
}
}
},
"projects": {
"resources": {
- "clusters": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "Operation"
- },
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters",
- "id": "dataproc.projects.clusters.create",
- "path": "v1beta1/projects/{projectId}/clusters",
- "description": "Creates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
- },
- "patch": {
- "httpMethod": "PATCH",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "updateMask": {
- "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfiguration.worker_configuration.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"configuration\":{\n \"workerConfiguration\":{\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, \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e and \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e are the only fields that can be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "id": "dataproc.projects.clusters.patch",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "description": "Updates a cluster in a project.",
- "request": {
- "$ref": "Cluster"
- }
- },
- "get": {
- "response": {
- "$ref": "Cluster"
- },
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required The cluster name.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "id": "dataproc.projects.clusters.get",
- "description": "Gets the resource representation for a cluster in a project."
- },
- "diagnose": {
- "httpMethod": "POST",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "description": "Required The cluster name.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}:diagnose",
- "id": "dataproc.projects.clusters.diagnose",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}:diagnose",
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
- "request": {
- "$ref": "DiagnoseClusterRequest"
- }
- },
- "delete": {
- "description": "Deletes a cluster in a project.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "projectId",
- "clusterName"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "clusterName": {
- "location": "path",
- "description": "Required The cluster name.",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
- "id": "dataproc.projects.clusters.delete",
- "path": "v1beta1/projects/{projectId}/clusters/{clusterName}"
- },
- "list": {
- "description": "Lists all clusters in a project.",
- "httpMethod": "GET",
- "parameterOrder": [
- "projectId"
- ],
- "response": {
- "$ref": "ListClustersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)",
- "type": "string"
- },
- "pageToken": {
- "description": "The standard List page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "The standard List page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "location": "path",
- "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectId}/clusters",
- "id": "dataproc.projects.clusters.list",
- "path": "v1beta1/projects/{projectId}/clusters"
- }
- }
- },
"jobs": {
"methods": {
"cancel": {
+ "path": "v1beta1/projects/{projectId}/jobs/{jobId}:cancel",
+ "id": "dataproc.projects.jobs.cancel",
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get.",
"request": {
"$ref": "CancelJobRequest"
},
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call jobs.list or jobs.get.",
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Job"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "Job"
- },
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
- "location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"description": "Required The job ID.",
@@ -367,22 +159,20 @@
"location": "path"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}:cancel",
- "id": "dataproc.projects.jobs.cancel",
- "path": "v1beta1/projects/{projectId}/jobs/{jobId}:cancel"
+ "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}:cancel"
},
"get": {
+ "response": {
+ "$ref": "Job"
+ },
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "Job"
- },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"projectId": {
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -397,32 +187,30 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}",
- "id": "dataproc.projects.jobs.get",
"path": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "id": "dataproc.projects.jobs.get",
"description": "Gets the resource representation for a job in a project."
},
"patch": {
- "httpMethod": "PATCH",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Updates a job in a project.",
+ "response": {
+ "$ref": "Job"
+ },
"parameterOrder": [
"projectId",
"jobId"
],
- "response": {
- "$ref": "Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "PATCH",
"parameters": {
"projectId": {
- "location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
},
"jobId": {
"description": "Required The job ID.",
@@ -437,13 +225,12 @@
"type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}",
- "id": "dataproc.projects.jobs.patch",
"path": "v1beta1/projects/{projectId}/jobs/{jobId}",
- "description": "Updates a job in a project.",
- "request": {
- "$ref": "Job"
- }
+ "id": "dataproc.projects.jobs.patch"
},
"submit": {
"response": {
@@ -458,10 +245,10 @@
],
"parameters": {
"projectId": {
- "location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1beta1/projects/{projectId}/jobs:submit",
@@ -473,9 +260,6 @@
}
},
"delete": {
- "path": "v1beta1/projects/{projectId}/jobs/{jobId}",
- "id": "dataproc.projects.jobs.delete",
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
"response": {
"$ref": "Empty"
},
@@ -489,21 +273,26 @@
],
"parameters": {
"projectId": {
+ "location": "path",
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"jobId": {
+ "location": "path",
"description": "Required The job ID.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
}
},
- "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}"
+ "flatPath": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "path": "v1beta1/projects/{projectId}/jobs/{jobId}",
+ "id": "dataproc.projects.jobs.delete",
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
},
"list": {
+ "id": "dataproc.projects.jobs.list",
+ "path": "v1beta1/projects/{projectId}/jobs",
"description": "Lists jobs in a project.",
"httpMethod": "GET",
"response": {
@@ -513,21 +302,10 @@
"projectId"
],
"parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional The page token, returned by a previous call, to request the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional The number of results to return in each response.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"clusterName": {
+ "location": "query",
"description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"projectId": {
"description": "Required The ID of the Google Cloud Platform project that the job belongs to.",
@@ -536,17 +314,232 @@
"location": "path"
},
"filter": {
+ "location": "query",
"description": "Optional A filter constraining which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"jobStateMatcher": {
+ "location": "query",
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
],
"description": "Optional Specifies enumerated categories of jobs to list.",
+ "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": {
+ "description": "Optional The number of results to return in each response.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/jobs"
+ }
+ }
+ },
+ "clusters": {
+ "methods": {
+ "create": {
+ "path": "v1beta1/projects/{projectId}/clusters",
+ "id": "dataproc.projects.clusters.create",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Creates a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/clusters"
+ },
+ "patch": {
+ "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
+ "id": "dataproc.projects.clusters.patch",
+ "request": {
+ "$ref": "Cluster"
+ },
+ "description": "Updates a cluster in a project.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "updateMask": {
+ "description": "Required Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfiguration.worker_configuration.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"configuration\":{\n \"workerConfiguration\":{\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, \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e and \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e are the only fields that can be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}"
+ },
+ "get": {
+ "id": "dataproc.projects.clusters.get",
+ "path": "v1beta1/projects/{projectId}/clusters/{clusterName}",
+ "description": "Gets the resource representation for a cluster in a project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Cluster"
+ },
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "parameters": {
+ "clusterName": {
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}"
+ },
+ "diagnose": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "clusterName": {
+ "location": "path",
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}:diagnose",
+ "path": "v1beta1/projects/{projectId}/clusters/{clusterName}:diagnose",
+ "id": "dataproc.projects.clusters.diagnose",
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
+ "request": {
+ "$ref": "DiagnoseClusterRequest"
+ }
+ },
+ "delete": {
+ "description": "Deletes a cluster in a project.",
+ "parameterOrder": [
+ "projectId",
+ "clusterName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "DELETE",
+ "parameters": {
+ "clusterName": {
+ "description": "Required The cluster name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "projectId": {
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectId}/clusters/{clusterName}",
+ "id": "dataproc.projects.clusters.delete",
+ "path": "v1beta1/projects/{projectId}/clusters/{clusterName}"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "projectId"
+ ],
+ "response": {
+ "$ref": "ListClustersResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The standard List page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The standard List page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "path",
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)",
"type": "string",
"location": "query"
}
@@ -554,9 +547,10 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectId}/jobs",
- "id": "dataproc.projects.jobs.list",
- "path": "v1beta1/projects/{projectId}/jobs"
+ "flatPath": "v1beta1/projects/{projectId}/clusters",
+ "id": "dataproc.projects.clusters.list",
+ "path": "v1beta1/projects/{projectId}/clusters",
+ "description": "Lists all clusters in a project."
}
}
}
@@ -564,50 +558,24 @@
}
},
"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": {
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string",
- "location": "query"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
"location": "query",
- "description": "OAuth 2.0 token for the current user.",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
@@ -632,52 +600,229 @@
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "callback": {
"location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
},
- "callback": {
+ "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": "JSONP",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
}
},
"schemas": {
- "DiskConfiguration": {
- "description": "Specifies the configuration of disk options for a group of VM instances.",
+ "ListClustersResponse": {
+ "description": "The list of all clusters in a project.",
"type": "object",
"properties": {
- "numLocalSsds": {
- "description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.",
- "format": "int32",
- "type": "integer"
+ "clusters": {
+ "description": "Output-only The clusters in the project.",
+ "type": "array",
+ "items": {
+ "$ref": "Cluster"
+ }
},
- "bootDiskSizeGb": {
- "description": "Optional Size in GB of the boot disk (default is 500GB).",
- "format": "int32",
- "type": "integer"
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
}
},
- "id": "DiskConfiguration"
+ "id": "ListClustersResponse"
},
- "JobStatus": {
- "description": "Cloud Dataproc job status.",
- "type": "object",
+ "ManagedGroupConfiguration": {
"properties": {
- "stateStartTime": {
- "description": "Output-only The time when this state was entered.",
- "format": "google-datetime",
+ "instanceGroupManagerName": {
+ "description": "Output-only The name of the Instance Group Manager for this group.",
"type": "string"
},
+ "instanceTemplateName": {
+ "description": "Output-only The name of the Instance Template used for the Managed Instance Group.",
+ "type": "string"
+ }
+ },
+ "id": "ManagedGroupConfiguration",
+ "description": "Specifies the resources used to actively manage an instance group.",
+ "type": "object"
+ },
+ "Job": {
+ "description": "A Cloud Dataproc job resource.",
+ "type": "object",
+ "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": {
+ "$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"
+ },
+ "submittedBy": {
+ "description": "Output-only The email address of the user submitting the job. For jobs submitted on the cluster, the address is \u003ccode\u003eusername@hostname\u003c/code\u003e.",
+ "type": "string"
+ },
+ "scheduling": {
+ "$ref": "JobScheduling",
+ "description": "Optional Job scheduling configuration."
+ },
+ "pigJob": {
+ "$ref": "PigJob",
+ "description": "Job is a Pig job."
+ },
+ "hiveJob": {
+ "description": "Job is a Hive job.",
+ "$ref": "HiveJob"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.",
+ "type": "object"
+ },
+ "driverOutputResourceUri": {
+ "description": "Output-only A URI pointing to the location of the stdout of the job's driver program.",
+ "type": "string"
+ },
+ "sparkSqlJob": {
+ "$ref": "SparkSqlJob",
+ "description": "Job is a SparkSql job."
+ },
+ "sparkJob": {
+ "$ref": "SparkJob",
+ "description": "Job is a Spark job."
+ },
+ "statusHistory": {
+ "description": "Output-only The previous job status.",
+ "type": "array",
+ "items": {
+ "$ref": "JobStatus"
+ }
+ },
+ "yarnApplications": {
+ "description": "Output-only The collection of YARN applications spun up by this job.",
+ "type": "array",
+ "items": {
+ "$ref": "YarnApplication"
+ }
+ },
+ "pysparkJob": {
+ "$ref": "PySparkJob",
+ "description": "Job is a Pyspark job."
+ },
+ "reference": {
+ "description": "Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
+ "$ref": "JobReference"
+ },
+ "interactive": {
+ "description": "Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.",
+ "type": "boolean"
+ },
+ "driverInputResourceUri": {
+ "description": "Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.",
+ "type": "string"
+ }
+ },
+ "id": "Job"
+ },
+ "SparkJob": {
+ "properties": {
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfiguration": {
+ "$ref": "LoggingConfiguration",
+ "description": "Optional The runtime log configuration 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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "fileUris": {
+ "description": "Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainJarFileUri": {
+ "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.",
+ "type": "string"
+ }
+ },
+ "id": "SparkJob",
+ "description": "A Cloud Dataproc job for running Spark applications on YARN.",
+ "type": "object"
+ },
+ "JobStatus": {
+ "properties": {
"state": {
"enum": [
"STATE_UNSPECIFIED",
@@ -709,26 +854,37 @@
"details": {
"description": "Optional Job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
"type": "string"
- }
- },
- "id": "JobStatus"
- },
- "ClusterOperationStatus": {
- "description": "The status of the operation.",
- "type": "object",
- "properties": {
+ },
"stateStartTime": {
- "description": "Output-only The time this state was entered.",
+ "description": "Output-only The time when this state was entered.",
"format": "google-datetime",
"type": "string"
+ }
+ },
+ "id": "JobStatus",
+ "description": "Cloud Dataproc job status.",
+ "type": "object"
+ },
+ "DiskConfiguration": {
+ "description": "Specifies the configuration of disk options for a group of VM instances.",
+ "type": "object",
+ "properties": {
+ "bootDiskSizeGb": {
+ "description": "Optional Size in GB of the boot disk (default is 500GB).",
+ "format": "int32",
+ "type": "integer"
},
+ "numLocalSsds": {
+ "description": "Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DiskConfiguration"
+ },
+ "ClusterOperationStatus": {
+ "properties": {
"state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
"enum": [
"UNKNOWN",
"PENDING",
@@ -736,7 +892,13 @@
"DONE"
],
"description": "Output-only A message containing the operation state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
},
"details": {
"description": "Output-onlyA message containing any operation metadata details.",
@@ -745,14 +907,34 @@
"innerState": {
"description": "Output-only A message containing the detailed operation state.",
"type": "string"
+ },
+ "stateStartTime": {
+ "description": "Output-only The time this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "ClusterOperationStatus"
+ "id": "ClusterOperationStatus",
+ "description": "The status of the operation.",
+ "type": "object"
},
"HadoopJob": {
- "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
- "type": "object",
"properties": {
+ "mainClass": {
+ "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
+ "type": "string"
+ },
+ "archiveUris": {
+ "description": "Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "mainJarFileUri": {
+ "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
+ "type": "string"
+ },
"jarFileUris": {
"description": "Optional Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"type": "array",
@@ -784,26 +966,15 @@
"items": {
"type": "string"
}
- },
- "mainClass": {
- "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
- "type": "string"
}
},
- "id": "HadoopJob"
+ "id": "HadoopJob",
+ "description": "A Cloud Dataproc job for running Hadoop MapReduce jobs on YARN.",
+ "type": "object"
},
"QueryList": {
+ "description": "A list of queries to run on a cluster.",
+ "type": "object",
"properties": {
"queries": {
"description": "Required The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
@@ -813,24 +984,13 @@
}
}
},
- "id": "QueryList",
- "description": "A list of queries to run on a cluster.",
- "type": "object"
+ "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.",
+ "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",
@@ -843,7 +1003,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.",
@@ -859,9 +1030,7 @@
"type": "number"
}
},
- "id": "YarnApplication",
- "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.",
- "type": "object"
+ "id": "YarnApplication"
},
"DiagnoseClusterRequest": {
"description": "A request to collect cluster diagnostic information.",
@@ -917,33 +1086,27 @@
"description": "Metadata describing the operation.",
"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"
- },
"HiveJob": {
"properties": {
+ "properties": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
+ "type": "object"
+ },
"continueOnFailure": {
"description": "Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
"queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
+ "$ref": "QueryList",
+ "description": "A list of queries."
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains Hive queries.",
"type": "string"
},
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
"scriptVariables": {
"additionalProperties": {
"type": "string"
@@ -951,49 +1114,68 @@
"description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
"type": "object"
},
- "properties": {
- "additionalProperties": {
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
+ "type": "array",
+ "items": {
"type": "string"
- },
- "description": "Optional A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
- "type": "object"
+ }
}
},
"id": "HiveJob",
"description": "A Cloud Dataproc job for running Hive queries on YARN.",
"type": "object"
},
- "DiagnoseClusterResults": {
- "description": "The location of diagnostic output.",
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "DiagnoseClusterResults": {
"properties": {
"outputUri": {
"description": "Output-only The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.",
"type": "string"
}
},
- "id": "DiagnoseClusterResults"
+ "id": "DiagnoseClusterResults",
+ "description": "The location of diagnostic output.",
+ "type": "object"
},
"SoftwareConfiguration": {
- "description": "Specifies the selection and configuration of software inside the cluster.",
- "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": {
"additionalProperties": {
"type": "string"
},
"description": "Optional The properties to set on daemon configuration files.Property keys are specified in \"prefix:property\" format, such as \"core:fs.defaultFS\". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf",
"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": "SoftwareConfiguration"
+ "id": "SoftwareConfiguration",
+ "description": "Specifies the selection and configuration of software inside the cluster.",
+ "type": "object"
},
"PySparkJob": {
+ "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
+ "type": "object",
"properties": {
+ "jarFileUris": {
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "loggingConfiguration": {
+ "$ref": "LoggingConfiguration",
+ "description": "Optional The runtime log configuration for job execution."
+ },
"properties": {
"additionalProperties": {
"type": "string"
@@ -1032,24 +1214,13 @@
"items": {
"type": "string"
}
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfiguration": {
- "$ref": "LoggingConfiguration",
- "description": "Optional The runtime log configuration for job execution."
}
},
- "id": "PySparkJob",
- "description": "A Cloud Dataproc job for running PySpark applications on YARN.",
- "type": "object"
+ "id": "PySparkJob"
},
"LoggingConfiguration": {
+ "description": "The runtime logging configuration of the job.",
+ "type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
@@ -1070,16 +1241,10 @@
"type": "object"
}
},
- "id": "LoggingConfiguration",
- "description": "The runtime logging configuration of the job.",
- "type": "object"
+ "id": "LoggingConfiguration"
},
"ClusterConfiguration": {
"properties": {
- "workerConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for worker instances in a cluster."
- },
"initializationActions": {
"description": "Optional Commands to execute on each node after configuration 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:\nROLE=$(/usr/share/google/get_metadata_value attributes/role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"type": "array",
@@ -1087,9 +1252,13 @@
"$ref": "NodeInitializationAction"
}
},
+ "workerConfiguration": {
+ "description": "Optional The Google Compute Engine configuration settings for worker instances in a cluster.",
+ "$ref": "InstanceGroupConfiguration"
+ },
"softwareConfiguration": {
- "description": "Optional The configuration settings for software inside the cluster.",
- "$ref": "SoftwareConfiguration"
+ "$ref": "SoftwareConfiguration",
+ "description": "Optional The configuration settings for software inside the cluster."
},
"gceClusterConfiguration": {
"description": "Required The shared Google Compute Engine configuration settings for all instances in a cluster.",
@@ -1100,12 +1269,12 @@
"type": "string"
},
"masterConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster."
+ "description": "Optional The Google Compute Engine configuration settings for the master instance in a cluster.",
+ "$ref": "InstanceGroupConfiguration"
},
"secondaryWorkerConfiguration": {
- "$ref": "InstanceGroupConfiguration",
- "description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster."
+ "description": "Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.",
+ "$ref": "InstanceGroupConfiguration"
}
},
"id": "ClusterConfiguration",
@@ -1113,6 +1282,8 @@
"type": "object"
},
"ClusterMetrics": {
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
+ "type": "object",
"properties": {
"yarnMetrics": {
"additionalProperties": {
@@ -1131,12 +1302,26 @@
"type": "object"
}
},
- "id": "ClusterMetrics",
- "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
- "type": "object"
+ "id": "ClusterMetrics"
},
"InstanceGroupConfiguration": {
"properties": {
+ "machineTypeUri": {
+ "description": "The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.",
+ "type": "string"
+ },
+ "imageUri": {
+ "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.",
+ "type": "string"
+ },
+ "isPreemptible": {
+ "description": "Specifies that this instance group contains Preemptible Instances.",
+ "type": "boolean"
+ },
+ "managedGroupConfiguration": {
+ "description": "Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.",
+ "$ref": "ManagedGroupConfiguration"
+ },
"instanceNames": {
"description": "The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).",
"type": "array",
@@ -1144,10 +1329,6 @@
"type": "string"
}
},
- "managedGroupConfiguration": {
- "$ref": "ManagedGroupConfiguration",
- "description": "Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
- },
"accelerators": {
"description": "Optional The Google Compute Engine accelerator configuration for these instances.",
"type": "array",
@@ -1163,18 +1344,6 @@
"diskConfiguration": {
"description": "Disk option configuration settings.",
"$ref": "DiskConfiguration"
- },
- "machineTypeUri": {
- "description": "The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.",
- "type": "string"
- },
- "imageUri": {
- "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.",
- "type": "string"
- },
- "isPreemptible": {
- "description": "Specifies that this instance group contains Preemptible Instances.",
- "type": "boolean"
}
},
"id": "InstanceGroupConfiguration",
@@ -1183,6 +1352,22 @@
},
"GceClusterConfiguration": {
"properties": {
+ "subnetworkUri": {
+ "description": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.",
+ "type": "string"
+ },
+ "networkUri": {
+ "description": "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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.",
+ "type": "string"
+ },
+ "zoneUri": {
+ "description": "Required The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone].",
+ "type": "string"
+ },
+ "internalIpOnly": {
+ "description": "If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
+ "type": "boolean"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -1190,10 +1375,6 @@
"description": "The Google Compute Engine metadata entries to add to all instances.",
"type": "object"
},
- "internalIpOnly": {
- "description": "If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.",
- "type": "boolean"
- },
"serviceAccountScopes": {
"description": "The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: - https://www.googleapis.com/auth/cloud.useraccounts.readonly - https://www.googleapis.com/auth/devstorage.read_write - https://www.googleapis.com/auth/logging.write If no scopes are specfied, the following defaults are also provided: - https://www.googleapis.com/auth/bigquery - https://www.googleapis.com/auth/bigtable.admin.table - https://www.googleapis.com/auth/bigtable.data - https://www.googleapis.com/auth/devstorage.full_control",
"type": "array",
@@ -1211,18 +1392,6 @@
"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": "The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.",
- "type": "string"
- },
- "networkUri": {
- "description": "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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.",
- "type": "string"
- },
- "zoneUri": {
- "description": "Required The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone].",
- "type": "string"
}
},
"id": "GceClusterConfiguration",
@@ -1230,10 +1399,10 @@
"type": "object"
},
"CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
"properties": {},
- "id": "CancelOperationRequest"
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object"
},
"DiagnoseClusterOutputLocation": {
"description": "The location of diagnostic output.",
@@ -1282,14 +1451,15 @@
"type": "object"
},
"OperationStatus": {
+ "description": "The status of the operation.",
+ "type": "object",
"properties": {
+ "stateStartTime": {
+ "description": "The time this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"state": {
- "enumDescriptions": [
- "Unused.",
- "The operation has been created.",
- "The operation is running.",
- "The operation is done; either cancelled or completed."
- ],
"enum": [
"UNKNOWN",
"PENDING",
@@ -1297,7 +1467,13 @@
"DONE"
],
"description": "A message containing the operation state.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Unused.",
+ "The operation has been created.",
+ "The operation is running.",
+ "The operation is done; either cancelled or completed."
+ ]
},
"details": {
"description": "A message containing any operation metadata details.",
@@ -1306,16 +1482,9 @@
"innerState": {
"description": "A message containing the detailed operation state.",
"type": "string"
- },
- "stateStartTime": {
- "description": "The time this state was entered.",
- "format": "google-datetime",
- "type": "string"
}
},
- "id": "OperationStatus",
- "description": "The status of the operation.",
- "type": "object"
+ "id": "OperationStatus"
},
"JobReference": {
"properties": {
@@ -1333,22 +1502,18 @@
"type": "object"
},
"SubmitJobRequest": {
- "description": "A request to submit a job.",
- "type": "object",
"properties": {
"job": {
- "$ref": "Job",
- "description": "Required The job resource."
+ "description": "Required The job resource.",
+ "$ref": "Job"
}
},
- "id": "SubmitJobRequest"
+ "id": "SubmitJobRequest",
+ "description": "A request to submit a job.",
+ "type": "object"
},
"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 will be a common set of message types for APIs to use.",
"type": "array",
@@ -1364,6 +1529,10 @@
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any 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",
@@ -1382,9 +1551,23 @@
},
"id": "JobScheduling"
},
+ "NodeInitializationAction": {
+ "properties": {
+ "executableFile": {
+ "description": "Required Google Cloud Storage URI of executable file.",
+ "type": "string"
+ },
+ "executionTimeout": {
+ "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "NodeInitializationAction",
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "type": "object"
+ },
"ListJobsResponse": {
- "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.",
@@ -1398,22 +1581,8 @@
}
}
},
- "id": "ListJobsResponse"
- },
- "NodeInitializationAction": {
- "properties": {
- "executionTimeout": {
- "description": "Optional Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
- "format": "google-duration",
- "type": "string"
- },
- "executableFile": {
- "description": "Required Google Cloud Storage URI of executable file.",
- "type": "string"
- }
- },
- "id": "NodeInitializationAction",
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
+ "id": "ListJobsResponse",
+ "description": "A list of jobs in a project.",
"type": "object"
},
"CancelJobRequest": {
@@ -1424,21 +1593,14 @@
},
"SparkSqlJob": {
"properties": {
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
- "type": "object"
+ "queryList": {
+ "description": "A list of queries.",
+ "$ref": "QueryList"
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains SQL queries.",
"type": "string"
},
- "queryList": {
- "description": "A list of queries.",
- "$ref": "QueryList"
- },
"scriptVariables": {
"additionalProperties": {
"type": "string"
@@ -1456,6 +1618,13 @@
"loggingConfiguration": {
"description": "Optional The runtime log configuration for job execution.",
"$ref": "LoggingConfiguration"
+ },
+ "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",
@@ -1463,6 +1632,8 @@
"type": "object"
},
"Cluster": {
+ "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
+ "type": "object",
"properties": {
"configuration": {
"$ref": "ClusterConfiguration",
@@ -1503,11 +1674,11 @@
"type": "string"
}
},
- "id": "Cluster",
- "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
- "type": "object"
+ "id": "Cluster"
},
"ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
@@ -1521,27 +1692,12 @@
}
}
},
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
+ "description": "Metadata describing the operation.",
+ "type": "object",
"properties": {
- "statusHistory": {
- "description": "Output-only Previous operation status.",
- "type": "array",
- "items": {
- "$ref": "OperationStatus"
- }
- },
- "clusterName": {
- "description": "Name of the cluster for the operation.",
- "type": "string"
- },
- "clusterUuid": {
- "description": "Cluster UUId for the operation.",
- "type": "string"
- },
"operationType": {
"description": "Output-only The operation type.",
"type": "string"
@@ -1560,15 +1716,26 @@
"status": {
"description": "Output-only Current operation status.",
"$ref": "OperationStatus"
+ },
+ "statusHistory": {
+ "description": "Output-only Previous operation status.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationStatus"
+ }
+ },
+ "clusterName": {
+ "description": "Name of the cluster for the operation.",
+ "type": "string"
+ },
+ "clusterUuid": {
+ "description": "Cluster UUId for the operation.",
+ "type": "string"
}
},
- "id": "OperationMetadata",
- "description": "Metadata describing the operation.",
- "type": "object"
+ "id": "OperationMetadata"
},
"JobPlacement": {
- "description": "Cloud Dataproc job configuration.",
- "type": "object",
"properties": {
"clusterName": {
"description": "Required The name of the cluster where the job will be submitted.",
@@ -1579,53 +1746,12 @@
"type": "string"
}
},
- "id": "JobPlacement"
- },
- "ClusterStatus": {
- "properties": {
- "state": {
- "enum": [
- "UNKNOWN",
- "CREATING",
- "RUNNING",
- "ERROR",
- "DELETING",
- "UPDATING"
- ],
- "description": "The cluster's state.",
- "type": "string",
- "enumDescriptions": [
- "The cluster state is unknown.",
- "The cluster is being created and set up. It is not ready for use.",
- "The cluster is currently running and healthy. It is ready for use.",
- "The cluster encountered an error. It is not ready for use.",
- "The cluster is being deleted. It cannot be used.",
- "The cluster is being updated. It continues to accept and process jobs."
- ]
- },
- "stateStartTime": {
- "description": "Time when this state was entered.",
- "format": "google-datetime",
- "type": "string"
- },
- "detail": {
- "description": "Optional details of cluster's state.",
- "type": "string"
- }
- },
- "id": "ClusterStatus",
- "description": "The status of a cluster and its instances.",
+ "id": "JobPlacement",
+ "description": "Cloud Dataproc job configuration.",
"type": "object"
},
"PigJob": {
"properties": {
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
- "type": "object"
- },
"continueOnFailure": {
"description": "Optional Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
@@ -1655,13 +1781,58 @@
"loggingConfiguration": {
"$ref": "LoggingConfiguration",
"description": "Optional The runtime log configuration 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",
"description": "A Cloud Dataproc job for running Pig queries on YARN.",
"type": "object"
},
+ "ClusterStatus": {
+ "properties": {
+ "state": {
+ "enumDescriptions": [
+ "The cluster state is unknown.",
+ "The cluster is being created and set up. It is not ready for use.",
+ "The cluster is currently running and healthy. It is ready for use.",
+ "The cluster encountered an error. It is not ready for use.",
+ "The cluster is being deleted. It cannot be used.",
+ "The cluster is being updated. It continues to accept and process jobs."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "CREATING",
+ "RUNNING",
+ "ERROR",
+ "DELETING",
+ "UPDATING"
+ ],
+ "description": "The cluster's state.",
+ "type": "string"
+ },
+ "stateStartTime": {
+ "description": "Time when this state was entered.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "detail": {
+ "description": "Optional details of cluster's state.",
+ "type": "string"
+ }
+ },
+ "id": "ClusterStatus",
+ "description": "The status of a cluster and its instances.",
+ "type": "object"
+ },
"AcceleratorConfiguration": {
+ "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
+ "type": "object",
"properties": {
"acceleratorCount": {
"description": "The number of the accelerator cards of this type exposed to this instance.",
@@ -1673,191 +1844,14 @@
"type": "string"
}
},
- "id": "AcceleratorConfiguration",
- "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
- "type": "object"
- },
- "ManagedGroupConfiguration": {
- "description": "Specifies the resources used to actively manage an instance group.",
- "type": "object",
- "properties": {
- "instanceGroupManagerName": {
- "description": "Output-only The name of the Instance Group Manager for this group.",
- "type": "string"
- },
- "instanceTemplateName": {
- "description": "Output-only The name of the Instance Template used for the Managed Instance Group.",
- "type": "string"
- }
- },
- "id": "ManagedGroupConfiguration"
- },
- "ListClustersResponse": {
- "description": "The list of all clusters in a project.",
- "type": "object",
- "properties": {
- "clusters": {
- "description": "Output-only The clusters in the project.",
- "type": "array",
- "items": {
- "$ref": "Cluster"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListClustersResponse"
- },
- "SparkJob": {
- "properties": {
- "mainClass": {
- "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
- "type": "string"
- },
- "archiveUris": {
- "description": "Optional HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "mainJarFileUri": {
- "description": "The Hadoop Compatible Filesystem (HCFS) URI of the jar file that contains the main class.",
- "type": "string"
- },
- "jarFileUris": {
- "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "loggingConfiguration": {
- "description": "Optional The runtime log configuration for job execution.",
- "$ref": "LoggingConfiguration"
- },
- "properties": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
- "type": "object"
- },
- "args": {
- "description": "Optional The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "fileUris": {
- "description": "Optional HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "SparkJob",
- "description": "A Cloud Dataproc job for running Spark applications on YARN.",
- "type": "object"
- },
- "Job": {
- "properties": {
- "hiveJob": {
- "$ref": "HiveJob",
- "description": "Job is a Hive job."
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional The labels to associate with this job.Label keys must 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"
- },
- "driverOutputResourceUri": {
- "description": "Output-only A URI pointing to the location of the stdout of the job's driver program.",
- "type": "string"
- },
- "sparkSqlJob": {
- "$ref": "SparkSqlJob",
- "description": "Job is a SparkSql job."
- },
- "sparkJob": {
- "$ref": "SparkJob",
- "description": "Job is a Spark job."
- },
- "statusHistory": {
- "description": "Output-only The previous job status.",
- "type": "array",
- "items": {
- "$ref": "JobStatus"
- }
- },
- "yarnApplications": {
- "description": "Output-only The collection of YARN applications spun up by this job.",
- "type": "array",
- "items": {
- "$ref": "YarnApplication"
- }
- },
- "pysparkJob": {
- "$ref": "PySparkJob",
- "description": "Job is a Pyspark job."
- },
- "reference": {
- "description": "Optional The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
- "$ref": "JobReference"
- },
- "interactive": {
- "description": "Optional If set to true, the driver's stdin will be kept open and driver_input_uri will be set to provide a path at which additional input can be sent to the driver.",
- "type": "boolean"
- },
- "driverInputResourceUri": {
- "description": "Output-only A URI pointing to the location of the stdin of the job's driver program, only set if the job is interactive.",
- "type": "string"
- },
- "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"
- },
- "submittedBy": {
- "description": "Output-only The email address of the user submitting the job. For jobs submitted on the cluster, the address is \u003ccode\u003eusername@hostname\u003c/code\u003e.",
- "type": "string"
- },
- "scheduling": {
- "description": "Optional Job scheduling configuration.",
- "$ref": "JobScheduling"
- },
- "pigJob": {
- "$ref": "PigJob",
- "description": "Job is a Pig job."
- }
- },
- "id": "Job",
- "description": "A Cloud Dataproc job resource.",
- "type": "object"
+ "id": "AcceleratorConfiguration"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"version": "v1beta1",
"baseUrl": "https://dataproc.googleapis.com/",
"auth": {
@@ -1876,5 +1870,11 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "dataproc",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "id": "dataproc:v1beta1",
+ "documentationLink": "https://cloud.google.com/dataproc/",
+ "revision": "20170228",
+ "title": "Google Cloud Dataproc API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
index 4992865..184e0b8 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,9 +1,16 @@
{
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
"CreateShortDynamicLinkResponse": {
+ "description": "Response to create a short Dynamic Link.",
+ "type": "object",
"properties": {
+ "warning": {
+ "description": "Information about potential warnings on link creation.",
+ "type": "array",
+ "items": {
+ "$ref": "DynamicLinkWarning"
+ }
+ },
"shortLink": {
"description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz",
"type": "string"
@@ -11,83 +18,9 @@
"previewLink": {
"description": "Preivew link to show the link flow chart.",
"type": "string"
- },
- "warning": {
- "description": "Information about potential warnings on link creation.",
- "type": "array",
- "items": {
- "$ref": "DynamicLinkWarning"
- }
}
},
- "id": "CreateShortDynamicLinkResponse",
- "description": "Response to create a short Dynamic Link.",
- "type": "object"
- },
- "IosInfo": {
- "properties": {
- "iosFallbackLink": {
- "description": "Link to open on iOS if the app is not installed.",
- "type": "string"
- },
- "iosAppStoreId": {
- "description": "iOS App Store ID.",
- "type": "string"
- },
- "iosIpadFallbackLink": {
- "description": "If specified, this overrides the ios_fallback_link value on iPads.",
- "type": "string"
- },
- "iosIpadBundleId": {
- "description": "iPad bundle ID of the app.",
- "type": "string"
- },
- "iosCustomScheme": {
- "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
- "type": "string"
- },
- "iosBundleId": {
- "description": "iOS bundle ID of the app.",
- "type": "string"
- }
- },
- "id": "IosInfo",
- "description": "iOS related attributes to the Dynamic Link..",
- "type": "object"
- },
- "AnalyticsInfo": {
- "properties": {
- "itunesConnectAnalytics": {
- "$ref": "ITunesConnectAnalytics",
- "description": "iTunes Connect App Analytics."
- },
- "googlePlayAnalytics": {
- "$ref": "GooglePlayAnalytics",
- "description": "Google Play Campaign Measurements."
- }
- },
- "id": "AnalyticsInfo",
- "description": "Tracking parameters supported by Dynamic Link.",
- "type": "object"
- },
- "CreateShortDynamicLinkRequest": {
- "description": "Request to create a short Dynamic Link.",
- "type": "object",
- "properties": {
- "longDynamicLink": {
- "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
- "type": "string"
- },
- "suffix": {
- "description": "Short Dynamic Link suffix. Optional.",
- "$ref": "Suffix"
- },
- "dynamicLinkInfo": {
- "$ref": "DynamicLinkInfo",
- "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
- }
- },
- "id": "CreateShortDynamicLinkRequest"
+ "id": "CreateShortDynamicLinkResponse"
},
"Suffix": {
"description": "Short Dynamic Link suffix.",
@@ -130,52 +63,60 @@
"description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.",
"type": "string"
},
- "gclid": {
- "description": "[AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords ads. This value is generated dynamically\nand should never be modified.",
- "type": "string"
- },
"utmCampaign": {
"description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.",
"type": "string"
+ },
+ "gclid": {
+ "description": "[AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords ads. This value is generated dynamically\nand should never be modified.",
+ "type": "string"
}
},
"id": "GooglePlayAnalytics"
},
"DynamicLinkInfo": {
+ "description": "Information about a Dynamic Link.",
+ "type": "object",
"properties": {
+ "androidInfo": {
+ "$ref": "AndroidInfo",
+ "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
+ },
+ "navigationInfo": {
+ "description": "Information of navigation behavior of a Firebase Dynamic Links.",
+ "$ref": "NavigationInfo"
+ },
+ "analyticsInfo": {
+ "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).",
+ "$ref": "AnalyticsInfo"
+ },
+ "dynamicLinkDomain": {
+ "description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#set-up-firebase-and-the-dynamic-links-sdk)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
+ "type": "string"
+ },
"link": {
"description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).\n\nRequired.",
"type": "string"
},
"iosInfo": {
- "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/ios#create-a-dynamic-link-programmatically).",
- "$ref": "IosInfo"
+ "$ref": "IosInfo",
+ "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/ios#create-a-dynamic-link-programmatically)."
},
"socialMetaTagInfo": {
- "$ref": "SocialMetaTagInfo",
- "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites."
- },
- "androidInfo": {
- "$ref": "AndroidInfo",
- "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
- },
- "analyticsInfo": {
- "$ref": "AnalyticsInfo",
- "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically)."
- },
- "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#set-up-firebase-and-the-dynamic-links-sdk)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.",
- "type": "string"
+ "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
+ "$ref": "SocialMetaTagInfo"
}
},
- "id": "DynamicLinkInfo",
- "description": "Information about a Dynamic Link.",
- "type": "object"
+ "id": "DynamicLinkInfo"
},
"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"
@@ -187,10 +128,6 @@
"pt": {
"description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.",
"type": "string"
- },
- "at": {
- "description": "Affiliate token used to create affiliate-coded links.",
- "type": "string"
}
},
"id": "ITunesConnectAnalytics"
@@ -199,10 +136,6 @@
"description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.",
"type": "object",
"properties": {
- "socialDescription": {
- "description": "A short description of the link. Optional.",
- "type": "string"
- },
"socialTitle": {
"description": "Title to be displayed. Optional.",
"type": "string"
@@ -210,6 +143,10 @@
"socialImageLink": {
"description": "An image url string. Optional.",
"type": "string"
+ },
+ "socialDescription": {
+ "description": "A short description of the link. Optional.",
+ "type": "string"
}
},
"id": "SocialMetaTagInfo"
@@ -223,6 +160,37 @@
"type": "string"
},
"warningCode": {
+ "enumDescriptions": [
+ "Unknown code.",
+ "The Android package does not match any in developer's DevConsole project.",
+ "The Android minimum version code has to be a valid integer.",
+ "Android package min version param is not needed, e.g. when\n'apn' is missing.",
+ "Android link is not a valid URI.",
+ "Android link param is not needed, e.g. when param 'al' and 'link' have\nthe same value..",
+ "Android fallback link is not a valid URI.",
+ "Android fallback link has an invalid (non http/https) URI scheme.",
+ "The iOS bundle ID does not match any in developer's DevConsole project.",
+ "The iPad bundle ID does not match any in developer's DevConsole project.",
+ "iOS URL scheme is not needed, e.g. when 'ibi' are 'ipbi' are all missing.",
+ "iOS app store ID format is incorrect, e.g. not numeric.",
+ "iOS app store ID is not needed.",
+ "iOS fallback link is not a valid URI.",
+ "iOS fallback link has an invalid (non http/https) URI scheme.",
+ "iPad fallback link is not a valid URI.",
+ "iPad fallback link has an invalid (non http/https) URI scheme.",
+ "Debug param format is incorrect.",
+ "isAd param format is incorrect.",
+ "Indicates a certain param is deprecated.",
+ "Indicates certain paramater is not recognized.",
+ "Indicates certain paramater is too long.",
+ "Social meta tag image link is not a valid URI.",
+ "Social meta tag image link has an invalid (non http/https) URI scheme.",
+ "",
+ "",
+ "Dynamic Link URL length is too long.",
+ "Dynamic Link URL contains fragments.",
+ "The iOS bundle ID does not match with the given iOS store ID."
+ ],
"enum": [
"CODE_UNSPECIFIED",
"NOT_IN_PROJECT_ANDROID_PACKAGE_NAME",
@@ -255,38 +223,7 @@
"NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID"
],
"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."
- ]
+ "type": "string"
}
},
"id": "DynamicLinkWarning"
@@ -295,6 +232,10 @@
"description": "Android related attributes to the Dynamic Link.",
"type": "object",
"properties": {
+ "androidLink": {
+ "description": "If specified, this overrides the ‘link’ parameter on Android.",
+ "type": "string"
+ },
"androidFallbackLink": {
"description": "Link to open on Android if the app is not installed.",
"type": "string"
@@ -306,20 +247,92 @@
"androidMinPackageVersionCode": {
"description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.",
"type": "string"
- },
- "androidLink": {
- "description": "If specified, this overrides the ‘link’ parameter on Android.",
- "type": "string"
}
},
"id": "AndroidInfo"
+ },
+ "NavigationInfo": {
+ "description": "Information of navigation behavior.",
+ "type": "object",
+ "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": {
+ "iosFallbackLink": {
+ "description": "Link to open on iOS if the app is not installed.",
+ "type": "string"
+ },
+ "iosAppStoreId": {
+ "description": "iOS App Store ID.",
+ "type": "string"
+ },
+ "iosIpadFallbackLink": {
+ "description": "If specified, this overrides the ios_fallback_link value on iPads.",
+ "type": "string"
+ },
+ "iosIpadBundleId": {
+ "description": "iPad bundle ID of the app.",
+ "type": "string"
+ },
+ "iosCustomScheme": {
+ "description": "Custom (destination) scheme to use for iOS. By default, we’ll use the\nbundle ID as the custom scheme. Developer can override this behavior using\nthis param.",
+ "type": "string"
+ },
+ "iosBundleId": {
+ "description": "iOS bundle ID of the app.",
+ "type": "string"
+ }
+ },
+ "id": "IosInfo"
+ },
+ "AnalyticsInfo": {
+ "description": "Tracking parameters supported by Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "itunesConnectAnalytics": {
+ "description": "iTunes Connect App Analytics.",
+ "$ref": "ITunesConnectAnalytics"
+ },
+ "googlePlayAnalytics": {
+ "$ref": "GooglePlayAnalytics",
+ "description": "Google Play Campaign Measurements."
+ }
+ },
+ "id": "AnalyticsInfo"
+ },
+ "CreateShortDynamicLinkRequest": {
+ "description": "Request to create a short Dynamic Link.",
+ "type": "object",
+ "properties": {
+ "suffix": {
+ "$ref": "Suffix",
+ "description": "Short Dynamic Link suffix. Optional."
+ },
+ "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"
+ }
+ },
+ "id": "CreateShortDynamicLinkRequest"
}
},
- "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": "Firebase Dynamic Links",
"auth": {
"oauth2": {
@@ -361,43 +374,64 @@
}
},
"parameters": {
- "upload_protocol": {
+ "quotaUser": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
+ "pp": {
+ "description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
},
- "callback": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
"location": "query",
- "description": "JSONP",
+ "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",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
"location": "query"
},
"alt": {
@@ -416,45 +450,26 @@
"description": "Data format for response.",
"default": "json"
},
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string",
"location": "query"
},
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "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"
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://firebasedynamiclinks.googleapis.com/",
- "kind": "discovery#restDescription",
"description": "Firebase Dynamic Links API enables third party developers to programmatically create and manage Dynamic Links.",
"servicePath": "",
+ "kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170228",
+ "id": "firebasedynamiclinks:v1",
"documentationLink": "https://firebase.google.com/docs/dynamic-links/",
- "id": "firebasedynamiclinks:v1"
+ "revision": "20170309",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
index 592bdf8..8849f31 100644
--- a/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
+++ b/firebasedynamiclinks/v1/firebasedynamiclinks-gen.go
@@ -296,6 +296,10 @@
// Required.
Link string `json:"link,omitempty"`
+ // NavigationInfo: Information of navigation behavior of a Firebase
+ // Dynamic Links.
+ NavigationInfo *NavigationInfo `json:"navigationInfo,omitempty"`
+
// SocialMetaTagInfo: Parameters for social meta tag params.
// Used to set meta tag data for link previews on social sites.
SocialMetaTagInfo *SocialMetaTagInfo `json:"socialMetaTagInfo,omitempty"`
@@ -555,6 +559,38 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// NavigationInfo: Information of navigation behavior.
+type NavigationInfo struct {
+ // EnableForcedRedirect: If this option is on, FDL click will be forced
+ // to redirect rather than
+ // show an interstitial page.
+ EnableForcedRedirect bool `json:"enableForcedRedirect,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "EnableForcedRedirect") 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. "EnableForcedRedirect") 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 *NavigationInfo) MarshalJSON() ([]byte, error) {
+ type noMethod NavigationInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// SocialMetaTagInfo: Parameters for social meta tag params.
// Used to set meta tag data for link previews on social sites.
type SocialMetaTagInfo struct {
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json
index 4a3181b..f899f9f 100644
--- a/firebaserules/v1/firebaserules-api.json
+++ b/firebaserules/v1/firebaserules-api.json
@@ -1,29 +1,22 @@
{
- "batchPath": "batch",
- "title": "Firebase Rules API",
- "ownerName": "Google",
"resources": {
"projects": {
"methods": {
"test": {
- "request": {
- "$ref": "TestRulesetRequest"
- },
- "description": "Test `Source` for syntactic and semantic correctness. Issues present in the\nrules, if any, will be returned to the caller with a description, severity,\nand source location.\n\nThe test method will typically be executed with a developer provided\n`Source`, but if regression testing is desired, this method may be\nexecuted against a `Ruleset` resource name and the `Source` will be\nretrieved from the persisted `Ruleset`.\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.userId\n && (imageName.endsWith('.png') || imageName.endsWith('.jpg'))\n && resource.mimeType.startsWith('image/')\n }\n }",
- "response": {
- "$ref": "TestRulesetResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "TestRulesetResponse"
+ },
"parameters": {
"name": {
+ "location": "path",
"description": "Name of the project.\n\nFormat: `projects/{project_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/.+$",
- "location": "path"
+ "pattern": "^projects/.+$"
}
},
"scopes": [
@@ -32,41 +25,18 @@
"https://www.googleapis.com/auth/firebase.readonly"
],
"flatPath": "v1/projects/{projectsId}:test",
+ "id": "firebaserules.projects.test",
"path": "v1/{+name}:test",
- "id": "firebaserules.projects.test"
+ "request": {
+ "$ref": "TestRulesetRequest"
+ },
+ "description": "Test `Source` for syntactic and semantic correctness. Issues present in the\nrules, if any, will be returned to the caller with a description, severity,\nand source location.\n\nThe test method will typically be executed with a developer provided\n`Source`, but if regression testing is desired, this method may be\nexecuted against a `Ruleset` resource name and the `Source` will be\nretrieved from the persisted `Ruleset`.\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.userId\n && (imageName.endsWith('.png') || imageName.endsWith('.jpg'))\n && resource.mimeType.startsWith('image/')\n }\n }"
}
},
"resources": {
"rulesets": {
"methods": {
- "delete": {
- "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
- "id": "firebaserules.projects.rulesets.delete",
- "path": "v1/{+name}",
- "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/rulesets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ]
- },
"get": {
- "description": "Get a `Ruleset` by name including the full `Source` contents.",
"response": {
"$ref": "Ruleset"
},
@@ -90,34 +60,35 @@
},
"flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
"path": "v1/{+name}",
- "id": "firebaserules.projects.rulesets.get"
+ "id": "firebaserules.projects.rulesets.get",
+ "description": "Get a `Ruleset` by name including the full `Source` contents."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "ListRulesetsResponse"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
"parameters": {
- "name": {
- "location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "location": "query",
- "description": "Next page token for loading the next batch of `Ruleset` instances.",
- "type": "string"
- },
"pageSize": {
"description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
"format": "int32",
"type": "integer",
"location": "query"
+ },
+ "name": {
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "Next page token for loading the next batch of `Ruleset` instances.",
+ "type": "string",
+ "location": "query"
}
},
"scopes": [
@@ -126,26 +97,22 @@
"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."
},
"create": {
- "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.",
"request": {
"$ref": "Ruleset"
},
- "response": {
- "$ref": "Ruleset"
- },
+ "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.",
+ "httpMethod": "POST",
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
+ "response": {
+ "$ref": "Ruleset"
+ },
"parameters": {
"name": {
"description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`",
@@ -155,26 +122,56 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
"flatPath": "v1/projects/{projectsId}/rulesets",
- "path": "v1/{+name}/rulesets",
- "id": "firebaserules.projects.rulesets.create"
+ "id": "firebaserules.projects.rulesets.create",
+ "path": "v1/{+name}/rulesets"
+ },
+ "delete": {
+ "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/rulesets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}",
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.rulesets.delete"
}
}
},
"releases": {
"methods": {
- "get": {
- "description": "Get a `Release` by name.",
+ "delete": {
+ "description": "Delete a `Release` by resource name.",
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
- "$ref": "Release"
+ "$ref": "Empty"
},
- "httpMethod": "GET",
"parameters": {
"name": {
- "description": "Resource name of the `Release`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`",
+ "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/releases/.+$",
@@ -183,75 +180,101 @@
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase",
- "https://www.googleapis.com/auth/firebase.readonly"
+ "https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.get"
+ "id": "firebaserules.projects.releases.delete",
+ "path": "v1/{+name}"
},
- "list": {
- "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.",
+ "get": {
+ "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
+ "id": "firebaserules.projects.releases.get",
+ "path": "v1/{+name}",
+ "description": "Get a `Release` by name.",
+ "httpMethod": "GET",
"response": {
- "$ref": "ListReleasesResponse"
+ "$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": {
- "pageSize": {
- "location": "query",
- "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release` `name` and also on the `Ruleset` `ruleset_name`.\n\nExample 1) A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters for\nrelease and ruleset names are relative to the project releases and rulesets\ncollections. Fully qualified prefixed may also be used. e.g.\n`name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`",
- "type": "string",
- "location": "query"
- },
"name": {
- "location": "path",
- "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "description": "Resource name of the `Release`.\n\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "pageToken": {
- "description": "Next page token for the next batch of `Release` instances.",
- "type": "string",
- "location": "query"
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path"
}
+ }
+ },
+ "list": {
+ "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name or `Ruleset` id or both.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ListReleasesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase",
"https://www.googleapis.com/auth/firebase.readonly"
],
+ "parameters": {
+ "filter": {
+ "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release` `name` and also on the `Ruleset` `ruleset_name`.\n\nExample 1) A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2) A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters for\nrelease and ruleset names are relative to the project releases and rulesets\ncollections. Fully qualified prefixed may also be used. e.g.\n`name=projects/foo/releases/prod* ruleset_name=projects/foo/rulesets/uuid1`",
+ "type": "string",
+ "location": "query"
+ },
+ "name": {
+ "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Next page token for the next batch of `Release` instances.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
"flatPath": "v1/projects/{projectsId}/releases",
- "path": "v1/{+name}/releases",
- "id": "firebaserules.projects.releases.list"
+ "id": "firebaserules.projects.releases.list",
+ "path": "v1/{+name}/releases"
},
"update": {
"request": {
"$ref": "Release"
},
"description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` field will be honored. `Release` rename\nis not supported. To create a `Release` use the CreateRelease method\ninstead.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Release"
},
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
"parameters": {
"name": {
- "location": "path",
"description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/releases/.+$"
+ "pattern": "^projects/[^/]+/releases/.+$",
+ "location": "path"
}
},
"scopes": [
@@ -259,8 +282,8 @@
"https://www.googleapis.com/auth/firebase"
],
"flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "id": "firebaserules.projects.releases.update",
- "path": "v1/{+name}"
+ "path": "v1/{+name}",
+ "id": "firebaserules.projects.releases.update"
},
"create": {
"request": {
@@ -290,32 +313,6 @@
"flatPath": "v1/projects/{projectsId}/releases",
"path": "v1/{+name}/releases",
"id": "firebaserules.projects.releases.create"
- },
- "delete": {
- "description": "Delete a `Release` by resource name.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/releases/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/firebase"
- ],
- "flatPath": "v1/projects/{projectsId}/releases/{releasesId}",
- "path": "v1/{+name}",
- "id": "firebaserules.projects.releases.delete"
}
}
}
@@ -323,27 +320,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.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
@@ -358,9 +334,9 @@
]
},
"callback": {
+ "location": "query",
"description": "JSONP",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"alt": {
"enumDescriptions": [
@@ -378,16 +354,16 @@
],
"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"
},
- "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.",
@@ -400,25 +376,46 @@
"default": "true"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "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"
}
},
"version": "v1",
"baseUrl": "https://firebaserules.googleapis.com/",
- "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"servicePath": "",
+ "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n",
"kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170210",
"id": "firebaserules:v1",
"documentationLink": "https://firebase.google.com/docs/storage/security",
+ "revision": "20170210",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
@@ -450,6 +447,10 @@
"description": "`File` containing source content.",
"type": "object",
"properties": {
+ "content": {
+ "description": "Textual Content.",
+ "type": "string"
+ },
"fingerprint": {
"description": "Fingerprint (e.g. github sha) associated with the `File`.",
"format": "byte",
@@ -458,10 +459,6 @@
"name": {
"description": "File name.",
"type": "string"
- },
- "content": {
- "description": "Textual Content.",
- "type": "string"
}
},
"id": "File"
@@ -509,16 +506,16 @@
"description": "The response for FirebaseRulesService.ListRulesets",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
+ "type": "string"
+ },
"rulesets": {
"description": "List of `Ruleset` instances.",
"type": "array",
"items": {
"$ref": "Ruleset"
}
- },
- "nextPageToken": {
- "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.",
- "type": "string"
}
},
"id": "ListRulesetsResponse"
@@ -541,6 +538,11 @@
"description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.",
"type": "object",
"properties": {
+ "column": {
+ "description": "First column on the source line associated with the source fragment.",
+ "format": "int32",
+ "type": "integer"
+ },
"fileName": {
"description": "Name of the `File`.",
"type": "string"
@@ -549,11 +551,6 @@
"description": "Line number of the source fragment. 1-based.",
"format": "int32",
"type": "integer"
- },
- "column": {
- "description": "First column on the source line associated with the source fragment.",
- "format": "int32",
- "type": "integer"
}
},
"id": "SourcePosition"
@@ -562,17 +559,11 @@
"description": "Issues include warnings, errors, and deprecation notices.",
"type": "object",
"properties": {
- "description": {
- "description": "Short error description.",
- "type": "string"
- },
"sourcePosition": {
- "description": "Position of the issue in the `Source`.",
- "$ref": "SourcePosition"
+ "$ref": "SourcePosition",
+ "description": "Position of the issue in the `Source`."
},
"severity": {
- "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.",
@@ -584,11 +575,37 @@
"DEPRECATION",
"WARNING",
"ERROR"
- ]
+ ],
+ "description": "The severity of the issue.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Short error description.",
+ "type": "string"
}
},
"id": "Issue"
},
+ "Ruleset": {
+ "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "Time the `Ruleset` was created.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\n@OutputOnly",
+ "type": "string"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "`Source` for the `Ruleset`."
+ }
+ },
+ "id": "Ruleset"
+ },
"TestRulesetRequest": {
"description": "The request for FirebaseRulesService.TestRuleset.",
"type": "object",
@@ -599,31 +616,11 @@
}
},
"id": "TestRulesetRequest"
- },
- "Ruleset": {
- "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.",
- "type": "object",
- "properties": {
- "source": {
- "description": "`Source` for the `Ruleset`.",
- "$ref": "Source"
- },
- "createTime": {
- "description": "Time the `Ruleset` was created.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "name": {
- "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\n@OutputOnly",
- "type": "string"
- }
- },
- "id": "Ruleset"
}
},
"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": "Firebase Rules API",
@@ -644,5 +641,8 @@
},
"rootUrl": "https://firebaserules.googleapis.com/",
"ownerDomain": "google.com",
- "name": "firebaserules"
+ "name": "firebaserules",
+ "batchPath": "batch",
+ "title": "Firebase Rules API",
+ "ownerName": "Google"
}
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json
index 7719efc..ea9de5d 100644
--- a/genomics/v1/genomics-api.json
+++ b/genomics/v1/genomics-api.json
@@ -1,9 +1,1736 @@
{
+ "documentationLink": "https://cloud.google.com/genomics",
+ "revision": "20170309",
+ "id": "genomics:v1",
+ "title": "Genomics API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "resources": {
+ "readgroupsets": {
+ "methods": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
+ "path": "v1/readgroupsets/{readGroupSetId}:export",
+ "id": "genomics.readgroupsets.export"
+ },
+ "search": {
+ "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",
+ "request": {
+ "$ref": "SearchReadGroupSetsRequest"
+ },
+ "description": "Searches for read group sets matching the criteria.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReadGroupSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/readmethods.avdl#L135).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReadGroupSetsResponse"
+ }
+ },
+ "patch": {
+ "parameters": {
+ "readGroupSetId": {
+ "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "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}",
+ "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"
+ }
+ },
+ "get": {
+ "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)",
+ "response": {
+ "$ref": "ReadGroupSet"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "readGroupSetId": {
+ "location": "path",
+ "description": "The ID of the read group set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}"
+ },
+ "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)",
+ "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/readgroupsets:import",
+ "path": "v1/readgroupsets:import",
+ "id": "genomics.readgroupsets.import"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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)"
+ }
+ },
+ "resources": {
+ "coveragebuckets": {
+ "methods": {
+ "list": {
+ "parameterOrder": [
+ "readGroupSetId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListCoverageBucketsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "start": {
+ "location": "query",
+ "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
+ "format": "int64",
+ "type": "string"
+ },
+ "readGroupSetId": {
+ "description": "Required. The ID of the read group set over which coverage is requested.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "targetBucketWidth": {
+ "location": "query",
+ "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
+ "format": "int64",
+ "type": "string"
+ },
+ "referenceName": {
+ "location": "query",
+ "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
+ "id": "genomics.readgroupsets.coveragebuckets.list",
+ "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset."
+ }
+ }
+ }
+ }
+ },
+ "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",
+ "id": "genomics.reads.search",
+ "path": "v1/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)."
+ }
+ }
+ },
+ "callsets": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "callSetId": {
+ "description": "The ID of the call set to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.delete",
+ "path": "v1/callsets/{callSetId}",
+ "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "search": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchCallSetsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets/search",
+ "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"
+ }
+ },
+ "patch": {
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.patch",
+ "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "callSetId": {
+ "location": "path",
+ "description": "The ID of the call set to be updated.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/callsets/{callSetId}"
+ },
+ "get": {
+ "path": "v1/callsets/{callSetId}",
+ "id": "genomics.callsets.get",
+ "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "parameterOrder": [
+ "callSetId"
+ ],
+ "response": {
+ "$ref": "CallSet"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "callSetId": {
+ "description": "The ID of the call set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/callsets/{callSetId}"
+ },
+ "create": {
+ "path": "v1/callsets",
+ "id": "genomics.callsets.create",
+ "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "CallSet"
+ },
+ "response": {
+ "$ref": "CallSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/callsets"
+ }
+ }
+ },
+ "variants": {
+ "methods": {
+ "merge": {
+ "id": "genomics.variants.merge",
+ "path": "v1/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"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants:merge"
+ },
+ "import": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/devstorage.read_write",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variants:import",
+ "id": "genomics.variants.import",
+ "path": "v1/variants:import",
+ "description": "Creates variant data by asynchronously importing the provided information.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe variants for import will be merged with any existing variant that\nmatches its reference sequence, start, end, reference bases, and\nalternative bases. If no such variant exists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant, and Variant info fields are merged\nas specified in\ninfoMergeConfig.\nAs a special case, for single-sample VCF files, QUAL and FILTER fields will\nbe moved to the call level; these are sometimes interpreted in a\ncall-specific context.\nImported VCF headers are appended to the metadata already in a variant set.",
+ "request": {
+ "$ref": "ImportVariantsRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant to be deleted.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.delete",
+ "path": "v1/variants/{variantId}",
+ "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)"
+ },
+ "create": {
+ "id": "genomics.variants.create",
+ "path": "v1/variants",
+ "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"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants"
+ },
+ "search": {
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variants/search",
+ "id": "genomics.variants.search",
+ "path": "v1/variants/search",
+ "request": {
+ "$ref": "SearchVariantsRequest"
+ },
+ "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchVariantsResponse"
+ }
+ },
+ "patch": {
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.patch",
+ "path": "v1/variants/{variantId}",
+ "request": {
+ "$ref": "Variant"
+ },
+ "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Variant"
+ }
+ },
+ "get": {
+ "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",
+ "parameterOrder": [
+ "variantId"
+ ],
+ "response": {
+ "$ref": "Variant"
+ },
+ "parameters": {
+ "variantId": {
+ "description": "The ID of the variant.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variants/{variantId}",
+ "id": "genomics.variants.get",
+ "path": "v1/variants/{variantId}"
+ }
+ }
+ },
+ "annotationsets": {
+ "methods": {
+ "delete": {
+ "id": "genomics.annotationsets.delete",
+ "path": "v1/annotationsets/{annotationSetId}",
+ "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/annotationsets/{annotationSetId}"
+ },
+ "search": {
+ "request": {
+ "$ref": "SearchAnnotationSetsRequest"
+ },
+ "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
+ "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",
+ "id": "genomics.annotationsets.search",
+ "path": "v1/annotationsets/search"
+ },
+ "get": {
+ "path": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.get",
+ "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be retrieved.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotationsets/{annotationSetId}"
+ },
+ "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"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "annotationSetId"
+ ],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "annotationSetId": {
+ "location": "path",
+ "description": "The ID of the annotation set to be updated.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/annotationsets/{annotationSetId}",
+ "id": "genomics.annotationsets.update",
+ "path": "v1/annotationsets/{annotationSetId}"
+ },
+ "create": {
+ "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
+ "request": {
+ "$ref": "AnnotationSet"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotationSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotationsets",
+ "id": "genomics.annotationsets.create",
+ "path": "v1/annotationsets"
+ }
+ }
+ },
+ "references": {
+ "methods": {
+ "search": {
+ "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
+ "request": {
+ "$ref": "SearchReferencesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchReferencesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/references/search",
+ "id": "genomics.references.search",
+ "path": "v1/references/search"
+ },
+ "get": {
+ "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).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "response": {
+ "$ref": "Reference"
+ },
+ "parameters": {
+ "referenceId": {
+ "location": "path",
+ "description": "The ID of the reference.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/references/{referenceId}"
+ }
+ },
+ "resources": {
+ "bases": {
+ "methods": {
+ "list": {
+ "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "referenceId"
+ ],
+ "response": {
+ "$ref": "ListBasesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "start": {
+ "description": "The start position (0-based) of this query. Defaults to 0.",
+ "format": "int64",
+ "type": "string",
+ "location": "query"
+ },
+ "referenceId": {
+ "location": "path",
+ "description": "The ID of the reference.",
+ "required": true,
+ "type": "string"
+ },
+ "end": {
+ "location": "query",
+ "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/references/{referenceId}/bases",
+ "id": "genomics.references.bases.list",
+ "path": "v1/references/{referenceId}/bases"
+ }
+ }
+ }
+ }
+ },
+ "datasets": {
+ "methods": {
+ "getIamPolicy": {
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "genomics.datasets.getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}",
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.get",
+ "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "patch": {
+ "id": "genomics.datasets.patch",
+ "path": "v1/datasets/{datasetId}",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
+ "httpMethod": "PATCH",
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be updated.",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetId}"
+ },
+ "undelete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be undeleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets/{datasetId}:undelete",
+ "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"
+ },
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "POST"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
+ "id": "genomics.datasets.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nSee \u003ca href=\"/iam/docs/managing-policies#testing_permissions\"\u003eTesting\nPermissions\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
+ },
+ "delete": {
+ "path": "v1/datasets/{datasetId}",
+ "id": "genomics.datasets.delete",
+ "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "datasetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "datasetId": {
+ "location": "path",
+ "description": "The ID of the dataset to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetId}"
+ },
+ "list": {
+ "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "ListDatasetsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "projectId": {
+ "location": "query",
+ "description": "Required. The Google Cloud project ID to list datasets for.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/datasets",
+ "path": "v1/datasets",
+ "id": "genomics.datasets.list"
+ },
+ "create": {
+ "id": "genomics.datasets.create",
+ "path": "v1/datasets",
+ "request": {
+ "$ref": "Dataset"
+ },
+ "description": "Creates a new dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Dataset"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^datasets/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "genomics.datasets.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information."
+ }
+ }
+ },
+ "annotations": {
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "httpMethod": "DELETE",
+ "parameters": {
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations/{annotationId}",
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.delete",
+ "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set."
+ },
+ "create": {
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/annotations",
+ "path": "v1/annotations",
+ "id": "genomics.annotations.create",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST"
+ },
+ "batchCreate": {
+ "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
+ "request": {
+ "$ref": "BatchCreateAnnotationsRequest"
+ },
+ "response": {
+ "$ref": "BatchCreateAnnotationsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/annotations:batchCreate",
+ "path": "v1/annotations:batchCreate",
+ "id": "genomics.annotations.batchCreate"
+ },
+ "search": {
+ "id": "genomics.annotations.search",
+ "path": "v1/annotations/search",
+ "request": {
+ "$ref": "SearchAnnotationsRequest"
+ },
+ "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "SearchAnnotationsResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/search"
+ },
+ "get": {
+ "id": "genomics.annotations.get",
+ "path": "v1/annotations/{annotationId}",
+ "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameters": {
+ "annotationId": {
+ "location": "path",
+ "description": "The ID of the annotation to be retrieved.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/annotations/{annotationId}"
+ },
+ "update": {
+ "path": "v1/annotations/{annotationId}",
+ "id": "genomics.annotations.update",
+ "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset.",
+ "request": {
+ "$ref": "Annotation"
+ },
+ "response": {
+ "$ref": "Annotation"
+ },
+ "parameterOrder": [
+ "annotationId"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "annotationId": {
+ "description": "The ID of the annotation to be updated.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/annotations/{annotationId}"
+ }
+ }
+ },
+ "variantsets": {
+ "methods": {
+ "delete": {
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.delete",
+ "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant set to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}"
+ },
+ "create": {
+ "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.",
+ "request": {
+ "$ref": "VariantSet"
+ },
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {},
+ "flatPath": "v1/variantsets",
+ "path": "v1/variantsets",
+ "id": "genomics.variantsets.create"
+ },
+ "export": {
+ "parameters": {
+ "variantSetId": {
+ "location": "path",
+ "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery",
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/variantsets/{variantSetId}:export",
+ "id": "genomics.variantsets.export",
+ "path": "v1/variantsets/{variantSetId}:export",
+ "request": {
+ "$ref": "ExportVariantSetRequest"
+ },
+ "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "response": {
+ "$ref": "Operation"
+ }
+ },
+ "search": {
+ "path": "v1/variantsets/search",
+ "id": "genomics.variantsets.search",
+ "request": {
+ "$ref": "SearchVariantSetsRequest"
+ },
+ "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
+ "response": {
+ "$ref": "SearchVariantSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/variantsets/search"
+ },
+ "get": {
+ "parameters": {
+ "variantSetId": {
+ "description": "Required. The ID of the variant set.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "flatPath": "v1/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)",
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "VariantSet"
+ }
+ },
+ "patch": {
+ "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "request": {
+ "$ref": "VariantSet"
+ },
+ "response": {
+ "$ref": "VariantSet"
+ },
+ "parameterOrder": [
+ "variantSetId"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "updateMask": {
+ "location": "query",
+ "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "variantSetId": {
+ "location": "path",
+ "description": "The ID of the variant to be updated (must already exist).",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/variantsets/{variantSetId}",
+ "path": "v1/variantsets/{variantSetId}",
+ "id": "genomics.variantsets.patch"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "id": "genomics.operations.cancel",
+ "path": "v1/{+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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}:cancel"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
+ "type": "string"
+ },
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/operations",
+ "id": "genomics.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request."
+ },
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "genomics.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ },
+ "referencesets": {
+ "methods": {
+ "search": {
+ "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)",
+ "request": {
+ "$ref": "SearchReferenceSetsRequest"
+ },
+ "response": {
+ "$ref": "SearchReferenceSetsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {},
+ "flatPath": "v1/referencesets/search",
+ "path": "v1/referencesets/search",
+ "id": "genomics.referencesets.search"
+ },
+ "get": {
+ "path": "v1/referencesets/{referenceSetId}",
+ "id": "genomics.referencesets.get",
+ "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).",
+ "parameterOrder": [
+ "referenceSetId"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ReferenceSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics",
+ "https://www.googleapis.com/auth/genomics.readonly"
+ ],
+ "parameters": {
+ "referenceSetId": {
+ "location": "path",
+ "description": "The ID of the reference set.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/referencesets/{referenceSetId}"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "type": "string",
+ "enumDescriptions": [
+ "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"
+ }
+ },
"schemas": {
+ "ReadGroup": {
+ "id": "ReadGroup",
+ "description": "A read group is all the data that's processed the same way by the sequencer.",
+ "type": "object",
+ "properties": {
+ "datasetId": {
+ "description": "The dataset to which this read group belongs.",
+ "type": "string"
+ },
+ "experiment": {
+ "description": "The experiment used to generate this read group.",
+ "$ref": "Experiment"
+ },
+ "name": {
+ "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The reference set the reads in this read group are aligned to.",
+ "type": "string"
+ },
+ "info": {
+ "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": {
+ "description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.",
+ "type": "string"
+ },
+ "predictedInsertSize": {
+ "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "programs": {
+ "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
+ "type": "array",
+ "items": {
+ "$ref": "Program"
+ }
+ },
+ "description": {
+ "description": "A free-form text description of this read group.",
+ "type": "string"
+ },
+ "sampleId": {
+ "description": "A client-supplied sample identifier for the reads in this read group.",
+ "type": "string"
+ }
+ }
+ },
+ "ReadGroupSet": {
+ "description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "datasetId": {
+ "description": "The dataset to which this read group set belongs.",
+ "type": "string"
+ },
+ "readGroups": {
+ "description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
+ "type": "array",
+ "items": {
+ "$ref": "ReadGroup"
+ }
+ },
+ "filename": {
+ "description": "The filename of the original source file for this read group set, if any.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "The reference set to which the reads in this read group set are aligned.",
+ "type": "string"
+ },
+ "info": {
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "description": "A map of additional read group set information.",
+ "type": "object"
+ },
+ "id": {
+ "description": "The server-generated read group set ID, unique for all read group sets.",
+ "type": "string"
+ }
+ },
+ "id": "ReadGroupSet"
+ },
+ "SearchVariantSetsResponse": {
+ "description": "The search variant sets response.",
+ "type": "object",
+ "properties": {
+ "variantSets": {
+ "description": "The variant sets belonging to the requested dataset.",
+ "type": "array",
+ "items": {
+ "$ref": "VariantSet"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ },
+ "id": "SearchVariantSetsResponse"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "Entry": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The creation status.",
+ "$ref": "Status"
+ },
+ "annotation": {
+ "$ref": "Annotation",
+ "description": "The created annotation, if creation was successful."
+ }
+ },
+ "id": "Entry"
+ },
"Position": {
"description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.",
"type": "object",
"properties": {
+ "reverseStrand": {
+ "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
+ "type": "boolean"
+ },
"position": {
"description": "The 0-based offset from the start of the forward strand for that reference.",
"format": "int64",
@@ -12,15 +1739,12 @@
"referenceName": {
"description": "The name of the reference in whatever reference set is being used.",
"type": "string"
- },
- "reverseStrand": {
- "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.",
- "type": "boolean"
}
},
"id": "Position"
},
"SearchReferenceSetsResponse": {
+ "id": "SearchReferenceSetsResponse",
"type": "object",
"properties": {
"referenceSets": {
@@ -34,13 +1758,21 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- },
- "id": "SearchReferenceSetsResponse"
+ }
},
"SearchCallSetsRequest": {
+ "id": "SearchCallSetsRequest",
"description": "The call set search request.",
"type": "object",
"properties": {
+ "name": {
+ "description": "Only return call sets for which a substring of the name matches this\nstring.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
"format": "int32",
@@ -52,22 +1784,18 @@
"items": {
"type": "string"
}
- },
- "name": {
- "description": "Only return call sets for which a substring of the name matches this\nstring.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
}
- },
- "id": "SearchCallSetsRequest"
+ }
},
"ImportReadGroupSetsRequest": {
+ "id": "ImportReadGroupSetsRequest",
"description": "The read group set import request.",
"type": "object",
"properties": {
+ "datasetId": {
+ "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
+ "type": "string"
+ },
"sourceUris": {
"description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.",
"type": "array",
@@ -92,25 +1820,13 @@
"PER_FILE_PER_SAMPLE",
"MERGE_ALL"
]
- },
- "datasetId": {
- "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.",
- "type": "string"
}
- },
- "id": "ImportReadGroupSetsRequest"
+ }
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"format": "byte",
@@ -120,14 +1836,109 @@
"description": "Version of the `Policy`. The default version is 0.",
"format": "int32",
"type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
}
},
"id": "Policy"
},
+ "Annotation": {
+ "id": "Annotation",
+ "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.",
+ "type": "object",
+ "properties": {
+ "annotationSetId": {
+ "description": "The annotation set to which this annotation belongs.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The display name of this annotation.",
+ "type": "string"
+ },
+ "variant": {
+ "$ref": "VariantAnnotation",
+ "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`."
+ },
+ "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"
+ },
+ "referenceName": {
+ "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
+ "type": "string"
+ },
+ "info": {
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
+ "A `VARIANT` annotation type.",
+ "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
+ "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
+ ],
+ "enum": [
+ "ANNOTATION_TYPE_UNSPECIFIED",
+ "GENERIC",
+ "VARIANT",
+ "GENE",
+ "TRANSCRIPT"
+ ],
+ "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position of the range on the reference, 0-based exclusive.",
+ "format": "int64",
+ "type": "string"
+ },
+ "transcript": {
+ "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.",
+ "$ref": "Transcript"
+ },
+ "start": {
+ "description": "The start position of the range on the reference, 0-based inclusive.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "CancelOperationRequest": {
+ "description": "The request message for Operations.CancelOperation.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
"SearchReadsRequest": {
+ "id": "SearchReadsRequest",
"description": "The read search request.",
"type": "object",
"properties": {
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.",
"format": "int32",
@@ -160,124 +1971,25 @@
"description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.",
"format": "int64",
"type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
}
- },
- "id": "SearchReadsRequest"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "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": {
- "info": {
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "type": {
- "description": "The data type for this annotation. Must match the containing annotation\nset's type.",
- "type": "string",
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
- "enum": [
- "ANNOTATION_TYPE_UNSPECIFIED",
- "GENERIC",
- "VARIANT",
- "GENE",
- "TRANSCRIPT"
- ]
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive.",
- "format": "int64",
- "type": "string"
- },
- "transcript": {
- "$ref": "Transcript",
- "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`."
- },
- "start": {
- "description": "The start position of the range on the reference, 0-based inclusive.",
- "format": "int64",
- "type": "string"
- },
- "annotationSetId": {
- "description": "The annotation set to which this annotation belongs.",
- "type": "string"
- },
- "name": {
- "description": "The display name of this annotation.",
- "type": "string"
- },
- "variant": {
- "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"
- },
- "referenceName": {
- "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.",
- "type": "string"
- }
- },
- "id": "Annotation"
+ }
},
"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"
},
"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": "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"
@@ -293,9 +2005,20 @@
"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": "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"
}
- },
- "id": "Operation"
+ }
},
"ImportReadGroupSetsResponse": {
"description": "The read group set import response.",
@@ -312,22 +2035,31 @@
"id": "ImportReadGroupSetsResponse"
},
"VariantCall": {
+ "id": "VariantCall",
"description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.",
"type": "object",
"properties": {
+ "genotype": {
+ "description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"phaseset": {
"description": "If this field is present, this variant call's genotype ordering implies\nthe phase of the bases and is consistent with any other variant calls in\nthe same reference sequence which have the same phaseset value.\nWhen importing data from VCF, if the genotype data was phased but no\nphase set was specified this field will be set to `*`.",
"type": "string"
},
"info": {
- "description": "A map of additional variant call information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "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.",
@@ -344,37 +2076,29 @@
"callSetId": {
"description": "The ID of the call set this variant call belongs to.",
"type": "string"
- },
- "genotype": {
- "description": "The genotype of this variant call. Each value represents either the value\nof the `referenceBases` field or a 1-based index into\n`alternateBases`. If a variant had a `referenceBases`\nvalue of `T` and an `alternateBases`\nvalue of `[\"A\", \"C\"]`, and the `genotype` was\n`[2, 1]`, that would mean the call\nrepresented the heterozygous value `CA` for this variant.\nIf the `genotype` was instead `[0, 1]`, the\nrepresented value would be `TA`. Ordering of the\ngenotype values is important if the `phaseset` is present.\nIf a genotype is not called (that is, a `.` is present in the\nGT string) -1 is returned.",
- "type": "array",
- "items": {
- "format": "int32",
- "type": "integer"
- }
}
- },
- "id": "VariantCall"
+ }
},
"SearchVariantsResponse": {
"description": "The variant search response.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"variants": {
"description": "The list of matching Variants.",
"type": "array",
"items": {
"$ref": "Variant"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
},
"id": "SearchVariantsResponse"
},
"ListBasesResponse": {
+ "id": "ListBasesResponse",
"type": "object",
"properties": {
"offset": {
@@ -390,18 +2114,13 @@
"description": "A substring of the bases that make up this reference.",
"type": "string"
}
- },
- "id": "ListBasesResponse"
+ }
},
"Status": {
+ "id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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"
@@ -410,17 +2129,22 @@
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
"type": "array",
"items": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
- }
+ },
+ "type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
}
- },
- "id": "Status"
+ }
},
"Binding": {
+ "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
@@ -435,13 +2159,12 @@
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
}
- },
- "id": "Binding"
+ }
},
"UndeleteDatasetRequest": {
+ "id": "UndeleteDatasetRequest",
"type": "object",
- "properties": {},
- "id": "UndeleteDatasetRequest"
+ "properties": {}
},
"Range": {
"description": "A 0-based half-open genomic coordinate range for search requests.",
@@ -468,14 +2191,6 @@
"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"
@@ -501,6 +2216,14 @@
"id": {
"description": "The server-generated variant set ID, unique across all variant sets.",
"type": "string"
+ },
+ "description": {
+ "description": "A textual description of this variant set.",
+ "type": "string"
+ },
+ "datasetId": {
+ "description": "The dataset to which this variant set belongs.",
+ "type": "string"
}
},
"id": "VariantSet"
@@ -534,25 +2257,26 @@
},
"id": "BatchCreateAnnotationsResponse"
},
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
+ "SearchCallSetsResponse": {
+ "description": "The call set search response.",
"type": "object",
"properties": {
"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"
},
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
+ "callSets": {
+ "description": "The list of matching call sets.",
"type": "array",
"items": {
- "$ref": "Operation"
+ "$ref": "CallSet"
}
}
},
- "id": "ListOperationsResponse"
+ "id": "SearchCallSetsResponse"
},
"Variant": {
+ "id": "Variant",
"description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.",
"type": "object",
"properties": {
@@ -569,28 +2293,28 @@
"type": "string"
},
"info": {
- "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
+ },
+ "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
},
"referenceBases": {
"description": "The reference bases for this variant. They start at the given\nposition.",
"type": "string"
},
- "alternateBases": {
- "description": "The bases that appear instead of the reference bases.",
+ "names": {
+ "description": "Names for the variant, for example a RefSNP ID.",
"type": "array",
"items": {
"type": "string"
}
},
- "names": {
- "description": "Names for the variant, for example a RefSNP ID.",
+ "alternateBases": {
+ "description": "The bases that appear instead of the reference bases.",
"type": "array",
"items": {
"type": "string"
@@ -630,36 +2354,90 @@
"format": "double",
"type": "number"
}
- },
- "id": "Variant"
+ }
},
- "SearchCallSetsResponse": {
- "description": "The call set search response.",
+ "ListOperationsResponse": {
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "callSets": {
- "description": "The list of matching call sets.",
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
- "$ref": "CallSet"
+ "$ref": "Operation"
}
},
"nextPageToken": {
- "description": "The 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"
}
+ }
+ },
+ "OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "createTime": {
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which the job stopped running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "events": {
+ "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationEvent"
+ }
+ },
+ "startTime": {
+ "description": "The time at which the job began to run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "request": {
+ "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"
+ }
},
- "id": "SearchCallSetsResponse"
+ "id": "OperationMetadata"
},
"SearchVariantsRequest": {
"description": "The variant search request.",
"type": "object",
"properties": {
- "end": {
- "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
- "format": "int64",
- "type": "string"
- },
"maxCalls": {
"description": "The maximum number of calls to return in a single page. Note that this\nlimit may be exceeded in the event that a matching variant contains more\ncalls than the requested maximum. If unspecified, defaults to 5000. The\nmaximum value is 10000.",
"format": "int32",
@@ -700,74 +2478,27 @@
"items": {
"type": "string"
}
+ },
+ "end": {
+ "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.",
+ "format": "int64",
+ "type": "string"
}
},
"id": "SearchVariantsRequest"
},
- "OperationMetadata": {
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "The Google Cloud Project in which the job is scoped.",
- "type": "string"
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
- "type": "string"
- },
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
- "type": "string"
- },
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "type": "array",
- "items": {
- "$ref": "OperationEvent"
- }
- },
- "startTime": {
- "description": "The time at which the job began to run.",
- "format": "google-datetime",
- "type": "string"
- },
- "request": {
- "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "runtimeMetadata": {
- "description": "Runtime metadata on this Operation.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.",
- "type": "object"
- },
- "createTime": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
"SearchReadGroupSetsRequest": {
+ "id": "SearchReadGroupSetsRequest",
"description": "The read group set search request.",
"type": "object",
"properties": {
+ "datasetIds": {
+ "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"name": {
"description": "Only return read group sets for which a substring of the name matches this\nstring.",
"type": "string"
@@ -780,35 +2511,28 @@
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 1024.",
"format": "int32",
"type": "integer"
- },
- "datasetIds": {
- "description": "Restricts this query to read group sets within the given datasets. At least\none ID must be provided.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
- },
- "id": "SearchReadGroupSetsRequest"
+ }
},
"SearchAnnotationsResponse": {
+ "id": "SearchAnnotationsResponse",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ },
"annotations": {
"description": "The matching annotations.",
"type": "array",
"items": {
"$ref": "Annotation"
}
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
}
- },
- "id": "SearchAnnotationsResponse"
+ }
},
"SearchReadsResponse": {
+ "id": "SearchReadsResponse",
"description": "The read search response.",
"type": "object",
"properties": {
@@ -823,12 +2547,18 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- },
- "id": "SearchReadsResponse"
+ }
},
"ClinicalCondition": {
"type": "object",
"properties": {
+ "externalIds": {
+ "description": "The set of external IDs for this condition.",
+ "type": "array",
+ "items": {
+ "$ref": "ExternalId"
+ }
+ },
"conceptId": {
"description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/",
"type": "string"
@@ -843,18 +2573,12 @@
"omimId": {
"description": "The OMIM id for this condition.\nSearch for these IDs at http://omim.org/",
"type": "string"
- },
- "externalIds": {
- "description": "The set of external IDs for this condition.",
- "type": "array",
- "items": {
- "$ref": "ExternalId"
- }
}
},
"id": "ClinicalCondition"
},
"Program": {
+ "id": "Program",
"type": "object",
"properties": {
"name": {
@@ -877,24 +2601,23 @@
"description": "The version of the program run.",
"type": "string"
}
- },
- "id": "Program"
+ }
},
"CoverageBucket": {
+ "id": "CoverageBucket",
"description": "A bucket over which read coverage has been precomputed. A bucket corresponds\nto a specific range of the reference sequence.",
"type": "object",
"properties": {
- "range": {
- "$ref": "Range",
- "description": "The genomic coordinate range spanned by this bucket."
- },
"meanCoverage": {
"description": "The average number of reads which are aligned to each individual\nreference base in this bucket.",
"format": "float",
"type": "number"
+ },
+ "range": {
+ "$ref": "Range",
+ "description": "The genomic coordinate range spanned by this bucket."
}
- },
- "id": "CoverageBucket"
+ }
},
"ComputeEngine": {
"description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
@@ -923,23 +2646,43 @@
"id": "ComputeEngine"
},
"ExternalId": {
+ "id": "ExternalId",
"type": "object",
"properties": {
- "id": {
- "description": "The id used by the source of this data.",
- "type": "string"
- },
"sourceName": {
"description": "The name of the source of this data.",
"type": "string"
+ },
+ "id": {
+ "description": "The id used by the source of this data.",
+ "type": "string"
}
- },
- "id": "ExternalId"
+ }
},
"Reference": {
"description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ncbiTaxonId": {
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
+ "format": "int32",
+ "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"
+ },
"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"
@@ -952,34 +2695,27 @@
"description": "The length of this reference's sequence.",
"format": "int64",
"type": "string"
- },
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `GCF_000001405.26`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "sourceUri": {
- "description": "The URI from which the sequence was obtained. Typically specifies a FASTA\nformat file.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy. For example, 9606 for human.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "The name of this reference, for example `22`.",
- "type": "string"
}
},
"id": "Reference"
},
"VariantSetMetadata": {
+ "id": "VariantSetMetadata",
"description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.",
"type": "object",
"properties": {
+ "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"
+ },
"key": {
"description": "The top-level key.",
"type": "string"
@@ -1017,26 +2753,17 @@
"CHARACTER",
"STRING"
]
- },
- "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"
}
- },
- "id": "VariantSetMetadata"
+ }
},
"SearchVariantSetsRequest": {
"description": "The search variant sets 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"
+ },
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.",
"format": "int32",
@@ -1048,10 +2775,6 @@
"items": {
"type": "string"
}
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
}
},
"id": "SearchVariantSetsRequest"
@@ -1059,6 +2782,17 @@
"SearchReferenceSetsRequest": {
"type": "object",
"properties": {
+ "accessions": {
+ "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 4096.",
"format": "int32",
@@ -1074,17 +2808,6 @@
"items": {
"type": "string"
}
- },
- "accessions": {
- "description": "If present, return reference sets for which a prefix of any of\nsourceAccessions\nmatch any of these strings. Accession numbers typically have a main number\nand a version, for example `NC_000001.11`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
}
},
"id": "SearchReferenceSetsRequest"
@@ -1129,48 +2852,10 @@
},
"id": "MergeVariantsRequest"
},
- "BatchCreateAnnotationsRequest": {
- "type": "object",
- "properties": {
- "annotations": {
- "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
- "type": "array",
- "items": {
- "$ref": "Annotation"
- }
- },
- "requestId": {
- "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": {
- "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": {
- "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
- "format": "int32",
- "type": "integer"
- },
"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"
@@ -1179,28 +2864,28 @@
"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"
},
+ "nextMatePosition": {
+ "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM.",
+ "$ref": "Position"
+ },
"info": {
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- }
- },
- "nextMatePosition": {
- "description": "The mapping of the primary alignment of the\n`(readNumber+1)%numberReads` read in the fragment. It replaces\nmate position and mate strand in SAM.",
- "$ref": "Position"
- },
- "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"
+ },
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
},
"properPlacement": {
"description": "The orientation and the distance between reads from the fragment are\nconsistent with the sequencing protocol (SAM flag 0x2).",
"type": "boolean"
},
+ "supplementaryAlignment": {
+ "description": "Whether this alignment is supplementary. Equivalent to SAM flag 0x800.\nSupplementary alignments are used in the representation of a chimeric\nalignment. In a chimeric alignment, a read is split into multiple\nlinear alignments that map to different reference contigs. The first\nlinear alignment in the read will be designated as the representative\nalignment; the remaining linear alignments will be designated as\nsupplementary alignments. These alignments may have different mapping\nquality scores. In each linear alignment in a chimeric alignment, the read\nwill be hard clipped. The `alignedSequence` and\n`alignedQuality` fields in the alignment record will only\nrepresent the bases for its respective linear alignment.",
+ "type": "boolean"
+ },
"fragmentLength": {
"description": "The observed length of the fragment, equivalent to TLEN in SAM.",
"format": "int32",
@@ -1219,82 +2904,64 @@
}
},
"alignment": {
- "$ref": "LinearAlignment",
- "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads."
+ "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads.",
+ "$ref": "LinearAlignment"
+ },
+ "id": {
+ "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
+ "type": "string"
},
"numberReads": {
"description": "The number of reads in the fragment (extension to SAM flag 0x1).",
"format": "int32",
"type": "integer"
},
- "id": {
- "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.",
- "type": "string"
- }
- },
- "id": "Read"
- },
- "ReferenceSet": {
- "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "referenceIds": {
- "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ "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"
},
- "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.",
+ "fragmentName": {
+ "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.",
"type": "string"
},
- "assemblyId": {
- "description": "Public id of this reference set, such as `GRCh37`.",
+ "readGroupSetId": {
+ "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.",
"type": "string"
},
- "id": {
- "description": "The server-generated reference set ID, unique across all reference sets.",
- "type": "string"
+ "duplicateFragment": {
+ "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).",
+ "type": "boolean"
},
- "sourceAccessions": {
- "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Free text description of this reference set.",
- "type": "string"
- },
- "sourceUri": {
- "description": "The URI from which the references were obtained.",
- "type": "string"
- },
- "ncbiTaxonId": {
- "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "readNumber": {
+ "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.",
"format": "int32",
"type": "integer"
}
},
- "id": "ReferenceSet"
+ "id": "Read"
+ },
+ "BatchCreateAnnotationsRequest": {
+ "type": "object",
+ "properties": {
+ "annotations": {
+ "description": "The annotations to be created. At most 4096 can be specified in a single\nrequest.",
+ "type": "array",
+ "items": {
+ "$ref": "Annotation"
+ }
+ },
+ "requestId": {
+ "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"
},
"CigarUnit": {
"description": "A single CIGAR operation.",
"type": "object",
"properties": {
- "referenceSequence": {
- "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.",
- "type": "string"
- },
- "operationLength": {
- "description": "The number of genomic bases that the operation runs for. Required.",
- "format": "int64",
- "type": "string"
- },
"operation": {
- "type": "string",
"enumDescriptions": [
"",
"An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.",
@@ -1318,15 +2985,101 @@
"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"
+ },
+ "operationLength": {
+ "description": "The number of genomic bases that the operation runs for. Required.",
+ "format": "int64",
+ "type": "string"
}
},
"id": "CigarUnit"
},
+ "ReferenceSet": {
+ "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The server-generated reference set ID, unique across all reference sets.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Free text description of this reference set.",
+ "type": "string"
+ },
+ "sourceAccessions": {
+ "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ncbiTaxonId": {
+ "description": "ID from http://www.ncbi.nlm.nih.gov/taxonomy (for example, 9606 for human)\nindicating the species which this reference set is intended to model. Note\nthat contained references may specify a different `ncbiTaxonId`, as\nassemblies may contain reference sequences which do not belong to the\nmodeled species, for example EBV in a human reference genome.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceUri": {
+ "description": "The URI from which the references were obtained.",
+ "type": "string"
+ },
+ "referenceIds": {
+ "description": "The IDs of the reference objects that are part of this set.\n`Reference.md5checksum` must be unique within this set.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "assemblyId": {
+ "description": "Public id of this reference set, such as `GRCh37`.",
+ "type": "string"
+ },
+ "md5checksum": {
+ "description": "Order-independent MD5 checksum which identifies this reference set. The\nchecksum is computed by sorting all lower case hexidecimal string\n`reference.md5checksum` (for all reference in this set) in\nascending lexicographic order, concatenating, and taking the MD5 of that\nvalue. The resulting value is represented in lower case hexadecimal format.",
+ "type": "string"
+ }
+ },
+ "id": "ReferenceSet"
+ },
+ "Transcript": {
+ "description": "A transcript represents the assertion that a particular region of the\nreference genome may be transcribed as RNA.",
+ "type": "object",
+ "properties": {
+ "geneId": {
+ "description": "The annotation ID of the gene from which this transcript is transcribed.",
+ "type": "string"
+ },
+ "exons": {
+ "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
+ "type": "array",
+ "items": {
+ "$ref": "Exon"
+ }
+ },
+ "codingSequence": {
+ "$ref": "CodingSequence",
+ "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA."
+ }
+ },
+ "id": "Transcript"
+ },
"AnnotationSet": {
"description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.",
"type": "object",
"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"
@@ -1335,6 +3088,16 @@
"description": "The ID of the reference set that defines the coordinate space for this\nset's annotations.",
"type": "string"
},
+ "info": {
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ },
+ "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object"
+ },
"type": {
"enumDescriptions": [
"",
@@ -1353,56 +3116,20 @@
"description": "The type of annotations contained within this set.",
"type": "string"
},
- "info": {
- "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
"id": {
"description": "The server-generated annotation set ID, unique across all annotation sets.",
"type": "string"
- },
- "datasetId": {
- "description": "The dataset to which this annotation set belongs.",
- "type": "string"
- },
- "sourceUri": {
- "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.",
- "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": {
- "exons": {
- "description": "The \u003ca href=\"http://en.wikipedia.org/wiki/Exon\"\u003eexons\u003c/a\u003e that compose\nthis transcript. This field should be unset for genomes where transcript\nsplicing does not occur, for example prokaryotes.\n\nIntrons are regions of the transcript that are not included in the\nspliced RNA product. Though not explicitly modeled here, intron ranges can\nbe deduced; all regions of this transcript that are not exons are introns.\n\nExonic sequences do not necessarily code for a translational product\n(amino acids). Only the regions of exons bounded by the\ncodingSequence correspond\nto coding DNA sequence.\n\nExons are ordered by start position and may not overlap.",
- "type": "array",
- "items": {
- "$ref": "Exon"
- }
- },
- "codingSequence": {
- "description": "The range of the coding sequence for this transcript, if any. To determine\nthe exact ranges of coding sequence, intersect this range with those of the\nexons, if any. If there are any\nexons, the\ncodingSequence must start\nand end within them.\n\nNote that in some cases, the reference genome will not exactly match the\nobserved mRNA transcript e.g. due to variance in the source genome from\nreference. In these cases,\nexon.frame will not necessarily\nmatch the expected reference reading frame and coding exon reference bases\ncannot necessarily be concatenated to produce the original transcript mRNA.",
- "$ref": "CodingSequence"
- },
- "geneId": {
- "description": "The annotation ID of the gene from which this transcript is transcribed.",
- "type": "string"
- }
- },
- "id": "Transcript"
- },
"Experiment": {
"type": "object",
"properties": {
+ "sequencingCenter": {
+ "description": "The sequencing center used as part of this experiment.",
+ "type": "string"
+ },
"platformUnit": {
"description": "The platform unit used as part of this experiment, for example\nflowcell-barcode.lane for Illumina or slide for SOLiD. Corresponds to the\n@RG PU field in the SAM spec.",
"type": "string"
@@ -1414,15 +3141,12 @@
"instrumentModel": {
"description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.",
"type": "string"
- },
- "sequencingCenter": {
- "description": "The sequencing center used as part of this experiment.",
- "type": "string"
}
},
"id": "Experiment"
},
"ListDatasetsResponse": {
+ "id": "ListDatasetsResponse",
"description": "The dataset list response.",
"type": "object",
"properties": {
@@ -1437,10 +3161,10 @@
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
}
- },
- "id": "ListDatasetsResponse"
+ }
},
"TestIamPermissionsRequest": {
+ "id": "TestIamPermissionsRequest",
"description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
@@ -1451,31 +3175,10 @@
"type": "string"
}
}
- },
- "id": "TestIamPermissionsRequest"
- },
- "Exon": {
- "type": "object",
- "properties": {
- "end": {
- "description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
- "format": "int64",
- "type": "string"
- },
- "frame": {
- "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "Exon"
+ }
},
"ExportReadGroupSetRequest": {
+ "id": "ExportReadGroupSetRequest",
"description": "The read group set export request.",
"type": "object",
"properties": {
@@ -1494,8 +3197,28 @@
"description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.",
"type": "string"
}
- },
- "id": "ExportReadGroupSetRequest"
+ }
+ },
+ "Exon": {
+ "id": "Exon",
+ "type": "object",
+ "properties": {
+ "start": {
+ "description": "The start position of the exon on this annotation's reference sequence,\n0-based inclusive. Note that this is relative to the reference start, and\n**not** the containing annotation start.",
+ "format": "int64",
+ "type": "string"
+ },
+ "end": {
+ "description": "The end position of the exon on this annotation's reference sequence,\n0-based exclusive. Note that this is relative to the reference start, and\n*not* the containing annotation start.",
+ "format": "int64",
+ "type": "string"
+ },
+ "frame": {
+ "description": "The frame of this exon. Contains a value of 0, 1, or 2, which indicates\nthe offset of the first coding base of the exon within the reading frame\nof the coding DNA sequence, if any. This field is dependent on the\nstrandedness of this annotation (see\nAnnotation.reverse_strand).\nFor forward stranded annotations, this offset is relative to the\nexon.start. For reverse\nstrand annotations, this offset is relative to the\nexon.end `- 1`.\n\nUnset if this exon does not intersect the coding sequence. Upon creation\nof a transcript, the frame must be populated for all or none of the\ncoding exons.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
},
"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)",
@@ -1515,14 +3238,14 @@
"type": "string"
},
"info": {
+ "description": "A map of additional call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
+ "type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "any"
}
- },
- "description": "A map of additional call set information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object"
+ }
},
"variantSetIds": {
"description": "The IDs of the variant sets this call set belongs to. This field must\nhave exactly length one, as a call set belongs to a single variant set.\nThis field is repeated for compatibility with the\n[GA4GH 0.5.1\nAPI](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variants.avdl#L76).",
@@ -1539,43 +3262,28 @@
"id": "CallSet"
},
"SearchAnnotationSetsResponse": {
+ "id": "SearchAnnotationSetsResponse",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- },
"annotationSets": {
"description": "The matching annotation sets.",
"type": "array",
"items": {
"$ref": "AnnotationSet"
}
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
}
- },
- "id": "SearchAnnotationSetsResponse"
+ }
},
"ImportVariantsRequest": {
+ "id": "ImportVariantsRequest",
"description": "The variant data import request.",
"type": "object",
"properties": {
- "format": {
- "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.",
- "type": "string",
- "enumDescriptions": [
- "",
- "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported.",
- "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed."
- ],
- "enum": [
- "FORMAT_UNSPECIFIED",
- "FORMAT_VCF",
- "FORMAT_COMPLETE_GENOMICS"
- ]
- },
"infoMergeConfig": {
- "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
- "type": "object",
"additionalProperties": {
"enum": [
"INFO_MERGE_OPERATION_UNSPECIFIED",
@@ -1583,7 +3291,9 @@
"MOVE_TO_CALLS"
],
"type": "string"
- }
+ },
+ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.",
+ "type": "object"
},
"variantSetId": {
"description": "Required. The variant set to which variant data should be imported.",
@@ -1599,20 +3309,26 @@
"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.",
+ "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"
+ }
},
"ListCoverageBucketsResponse": {
"type": "object",
"properties": {
- "coverageBuckets": {
- "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
- "type": "array",
- "items": {
- "$ref": "CoverageBucket"
- }
- },
"nextPageToken": {
"description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
"type": "string"
@@ -1621,6 +3337,13 @@
"description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).",
"format": "int64",
"type": "string"
+ },
+ "coverageBuckets": {
+ "description": "The coverage buckets. The list of buckets is sparse; a bucket with 0\noverlapping reads is not returned. A bucket never crosses more than one\nreference sequence. Each bucket has width `bucketWidth`, unless\nits end is the end of the reference sequence.",
+ "type": "array",
+ "items": {
+ "$ref": "CoverageBucket"
+ }
}
},
"id": "ListCoverageBucketsResponse"
@@ -1628,30 +3351,6 @@
"VariantAnnotation": {
"type": "object",
"properties": {
- "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"
@@ -1661,8 +3360,6 @@
"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.",
@@ -1694,7 +3391,9 @@
"ASSOCIATION",
"PROTECTIVE",
"MULTIPLE_REPORTED"
- ]
+ ],
+ "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/",
+ "type": "string"
},
"conditions": {
"description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.",
@@ -1735,6 +3434,30 @@
"items": {
"type": "string"
}
+ },
+ "type": {
+ "enumDescriptions": [
+ "",
+ "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.",
+ "`INSERTION` indicates an insertion.",
+ "`DELETION` indicates a deletion.",
+ "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.",
+ "`SNP` indicates a single nucleotide polymorphism.",
+ "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.",
+ "`CNV` indicates a variation in copy number."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_OTHER",
+ "INSERTION",
+ "DELETION",
+ "SUBSTITUTION",
+ "SNP",
+ "STRUCTURAL",
+ "CNV"
+ ],
+ "description": "Type has been adapted from ClinVar's list of variant types.",
+ "type": "string"
}
},
"id": "VariantAnnotation"
@@ -1778,8 +3501,13 @@
"id": "ExportVariantSetRequest"
},
"SearchAnnotationsRequest": {
+ "id": "SearchAnnotationsRequest",
"type": "object",
"properties": {
+ "referenceId": {
+ "description": "The ID of the reference to query.",
+ "type": "string"
+ },
"end": {
"description": "The end position of the range on the reference, 0-based exclusive. If\nreferenceId or\nreferenceName\nmust be specified, Defaults to the length of the reference.",
"format": "int64",
@@ -1809,22 +3537,14 @@
"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"
}
- },
- "id": "SearchAnnotationsRequest"
+ }
},
"OperationEvent": {
+ "id": "OperationEvent",
"description": "An event that occurred during an Operation.",
"type": "object",
"properties": {
- "description": {
- "description": "Required description of event.",
- "type": "string"
- },
"endTime": {
"description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
"format": "google-datetime",
@@ -1834,25 +3554,51 @@
"description": "Optional time of when event started.",
"format": "google-datetime",
"type": "string"
+ },
+ "description": {
+ "description": "Required description of event.",
+ "type": "string"
}
- },
- "id": "OperationEvent"
+ }
},
"CodingSequence": {
+ "id": "CodingSequence",
"type": "object",
"properties": {
- "end": {
- "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
- "format": "int64",
- "type": "string"
- },
"start": {
"description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
"format": "int64",
"type": "string"
+ },
+ "end": {
+ "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.",
+ "format": "int64",
+ "type": "string"
}
- },
- "id": "CodingSequence"
+ }
+ },
+ "SearchReferencesResponse": {
+ "id": "SearchReferencesResponse",
+ "type": "object",
+ "properties": {
+ "references": {
+ "description": "The matching references.",
+ "type": "array",
+ "items": {
+ "$ref": "Reference"
+ }
+ },
+ "nextPageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
+ "type": "string"
+ }
+ }
+ },
+ "GetIamPolicyRequest": {
+ "id": "GetIamPolicyRequest",
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {}
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
@@ -1868,32 +3614,22 @@
},
"id": "TestIamPermissionsResponse"
},
- "GetIamPolicyRequest": {
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {},
- "id": "GetIamPolicyRequest"
- },
- "SearchReferencesResponse": {
- "type": "object",
- "properties": {
- "references": {
- "description": "The matching references.",
- "type": "array",
- "items": {
- "$ref": "Reference"
- }
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchReferencesResponse"
- },
"SearchAnnotationSetsRequest": {
+ "id": "SearchAnnotationSetsRequest",
"type": "object",
"properties": {
+ "name": {
+ "description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
+ "type": "string"
+ },
+ "referenceSetId": {
+ "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
+ "type": "string"
+ },
"pageSize": {
"description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 128. The maximum value is 1024.",
"format": "int32",
@@ -1907,40 +3643,27 @@
}
},
"types": {
- "enumDescriptions": [
- "",
- "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.",
- "A `VARIANT` annotation type.",
- "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.",
- "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA."
- ],
"description": "If specified, only annotation sets that have any of these types are\nreturned.",
"type": "array",
"items": {
- "type": "string",
"enum": [
"ANNOTATION_TYPE_UNSPECIFIED",
"GENERIC",
"VARIANT",
"GENE",
"TRANSCRIPT"
- ]
- }
- },
- "name": {
- "description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).",
- "type": "string"
- },
- "referenceSetId": {
- "description": "If specified, only annotation sets associated with the given reference set\nare returned.",
- "type": "string"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
+ ],
+ "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."
+ ]
}
- },
- "id": "SearchAnnotationSetsRequest"
+ }
},
"SearchReadGroupSetsResponse": {
"description": "The read group set search response.",
@@ -1997,14 +3720,9 @@
"description": "A linear alignment can be represented by one CIGAR string. Describes the\nmapped position and local alignment of the read to the reference.",
"type": "object",
"properties": {
- "mappingQuality": {
- "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
- "format": "int32",
- "type": "integer"
- },
"position": {
- "$ref": "Position",
- "description": "The position of this alignment."
+ "description": "The position of this alignment.",
+ "$ref": "Position"
},
"cigar": {
"description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.",
@@ -2012,6 +3730,11 @@
"items": {
"$ref": "CigarUnit"
}
+ },
+ "mappingQuality": {
+ "description": "The mapping quality of this alignment. Represents how likely\nthe read maps to this position as opposed to other locations.\n\nSpecifically, this is -10 log10 Pr(mapping position is wrong), rounded to\nthe nearest integer.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "LinearAlignment"
@@ -2020,6 +3743,10 @@
"description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
"type": "object",
"properties": {
+ "id": {
+ "description": "The server-generated dataset ID, unique across all datasets.",
+ "type": "string"
+ },
"createTime": {
"description": "The time this dataset was created, in seconds from the epoch.",
"format": "google-datetime",
@@ -2032,15 +3759,12 @@
"projectId": {
"description": "The Google Cloud project ID that this dataset belongs to.",
"type": "string"
- },
- "id": {
- "description": "The server-generated dataset ID, unique across all datasets.",
- "type": "string"
}
},
"id": "Dataset"
},
"ImportVariantsResponse": {
+ "id": "ImportVariantsResponse",
"description": "The variant data import response.",
"type": "object",
"properties": {
@@ -2051,147 +3775,7 @@
"type": "string"
}
}
- },
- "id": "ImportVariantsResponse"
- },
- "ReadGroup": {
- "description": "A read group is all the data that's processed the same way by the sequencer.",
- "type": "object",
- "properties": {
- "description": {
- "description": "A free-form text description of this read group.",
- "type": "string"
- },
- "sampleId": {
- "description": "A client-supplied sample identifier for the reads in this read group.",
- "type": "string"
- },
- "datasetId": {
- "description": "The dataset to which this read group belongs.",
- "type": "string"
- },
- "experiment": {
- "$ref": "Experiment",
- "description": "The experiment used to generate this read group."
- },
- "name": {
- "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The reference set the reads in this read group are aligned to.",
- "type": "string"
- },
- "info": {
- "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "id": {
- "description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.",
- "type": "string"
- },
- "predictedInsertSize": {
- "description": "The predicted insert size of this read group. The insert size is the length\nthe sequenced DNA fragment from end-to-end, not including the adapters.",
- "format": "int32",
- "type": "integer"
- },
- "programs": {
- "description": "The programs used to generate this read group. Programs are always\nidentical for all read groups within a read group set. For this reason,\nonly the first read group in a returned set will have this field\npopulated.",
- "type": "array",
- "items": {
- "$ref": "Program"
- }
- }
- },
- "id": "ReadGroup"
- },
- "ReadGroupSet": {
- "description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "type": "object",
- "properties": {
- "datasetId": {
- "description": "The dataset to which this read group set belongs.",
- "type": "string"
- },
- "readGroups": {
- "description": "The read groups in this set. There are typically 1-10 read groups in a read\ngroup set.",
- "type": "array",
- "items": {
- "$ref": "ReadGroup"
- }
- },
- "filename": {
- "description": "The filename of the original source file for this read group set, if any.",
- "type": "string"
- },
- "name": {
- "description": "The read group set name. By default this will be initialized to the sample\nname of the sequenced data contained in this set.",
- "type": "string"
- },
- "referenceSetId": {
- "description": "The reference set to which the reads in this read group set are aligned.",
- "type": "string"
- },
- "info": {
- "description": "A map of additional read group set information.",
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "type": "any"
- }
- }
- },
- "id": {
- "description": "The server-generated read group set ID, unique for all read group sets.",
- "type": "string"
- }
- },
- "id": "ReadGroupSet"
- },
- "SearchVariantSetsResponse": {
- "description": "The search variant sets response.",
- "type": "object",
- "properties": {
- "variantSets": {
- "description": "The variant sets belonging to the requested dataset.",
- "type": "array",
- "items": {
- "$ref": "VariantSet"
- }
- },
- "nextPageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.",
- "type": "string"
- }
- },
- "id": "SearchVariantSetsResponse"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "Entry": {
- "type": "object",
- "properties": {
- "status": {
- "$ref": "Status",
- "description": "The creation status."
- },
- "annotation": {
- "$ref": "Annotation",
- "description": "The created annotation, if creation was successful."
- }
- },
- "id": "Entry"
+ }
}
},
"icons": {
@@ -2204,6 +3788,12 @@
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/bigquery": {
+ "description": "View and manage your data in Google BigQuery"
+ },
+ "https://www.googleapis.com/auth/devstorage.read_write": {
+ "description": "Manage your data in Google Cloud Storage"
+ },
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
@@ -2212,12 +3802,6 @@
},
"https://www.googleapis.com/auth/genomics": {
"description": "View and manage Genomics data"
- },
- "https://www.googleapis.com/auth/bigquery": {
- "description": "View and manage your data in Google BigQuery"
- },
- "https://www.googleapis.com/auth/devstorage.read_write": {
- "description": "Manage your data in Google Cloud Storage"
}
}
}
@@ -2229,1589 +3813,5 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "genomics",
- "batchPath": "batch",
- "id": "genomics:v1",
- "documentationLink": "https://cloud.google.com/genomics",
- "revision": "20170306",
- "title": "Genomics API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "resources": {
- "references": {
- "methods": {
- "search": {
- "request": {
- "$ref": "SearchReferencesRequest"
- },
- "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$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",
- "id": "genomics.references.search",
- "path": "v1/references/search"
- },
- "get": {
- "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).",
- "httpMethod": "GET",
- "parameterOrder": [
- "referenceId"
- ],
- "response": {
- "$ref": "Reference"
- },
- "parameters": {
- "referenceId": {
- "description": "The ID of the reference.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- }
- },
- "resources": {
- "bases": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListBasesResponse"
- },
- "parameterOrder": [
- "referenceId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "The maximum number of bases to return in a single page. If unspecified,\ndefaults to 200Kbp (kilo base pairs). The maximum value is 10Mbp (mega base\npairs).",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "location": "query",
- "description": "The start position (0-based) of this query. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "referenceId": {
- "location": "path",
- "description": "The ID of the reference.",
- "required": true,
- "type": "string"
- },
- "end": {
- "location": "query",
- "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.",
- "format": "int64",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string"
- }
- },
- "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",
- "path": "v1/references/{referenceId}/bases",
- "id": "genomics.references.bases.list",
- "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221)."
- }
- }
- }
- }
- },
- "datasets": {
- "methods": {
- "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)",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "genomics.datasets.testIamPermissions"
- },
- "delete": {
- "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}",
- "path": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.delete"
- },
- "list": {
- "flatPath": "v1/datasets",
- "path": "v1/datasets",
- "id": "genomics.datasets.list",
- "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "ListDatasetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "pageSize": {
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "projectId": {
- "description": "Required. The Google Cloud project ID to list datasets for.",
- "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"
- }
- }
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "genomics.datasets.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information."
- },
- "create": {
- "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)",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Dataset"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets",
- "id": "genomics.datasets.create",
- "path": "v1/datasets"
- },
- "getIamPolicy": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^datasets/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetsId}:getIamPolicy",
- "id": "genomics.datasets.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "request": {
- "$ref": "GetIamPolicyRequest"
- },
- "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "Dataset"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset to be updated.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1/datasets/{datasetId}",
- "id": "genomics.datasets.patch",
- "path": "v1/datasets/{datasetId}"
- },
- "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)",
- "httpMethod": "GET",
- "parameterOrder": [
- "datasetId"
- ],
- "response": {
- "$ref": "Dataset"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset.",
- "required": true,
- "type": "string"
- }
- }
- },
- "undelete": {
- "request": {
- "$ref": "UndeleteDatasetRequest"
- },
- "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.",
- "response": {
- "$ref": "Dataset"
- },
- "parameterOrder": [
- "datasetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "datasetId": {
- "location": "path",
- "description": "The ID of the dataset to be undeleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/datasets/{datasetId}:undelete",
- "path": "v1/datasets/{datasetId}:undelete",
- "id": "genomics.datasets.undelete"
- }
- }
- },
- "variantsets": {
- "methods": {
- "export": {
- "flatPath": "v1/variantsets/{variantSetId}:export",
- "path": "v1/variantsets/{variantSetId}:export",
- "id": "genomics.variantsets.export",
- "request": {
- "$ref": "ExportVariantSetRequest"
- },
- "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "POST",
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery",
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "search": {
- "request": {
- "$ref": "SearchVariantSetsRequest"
- },
- "description": "Returns a list of all variant sets matching search criteria.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariantSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L49).",
- "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",
- "id": "genomics.variantsets.search",
- "path": "v1/variantsets/search"
- },
- "get": {
- "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "GET",
- "parameterOrder": [
- "variantSetId"
- ],
- "response": {
- "$ref": "VariantSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "variantSetId": {
- "description": "Required. The ID of the variant set.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.get",
- "path": "v1/variantsets/{variantSetId}"
- },
- "patch": {
- "response": {
- "$ref": "VariantSet"
- },
- "parameterOrder": [
- "variantSetId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "variantSetId": {
- "description": "The ID of the variant to be updated (must already exist).",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/variantsets/{variantSetId}",
- "path": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.patch",
- "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "request": {
- "$ref": "VariantSet"
- }
- },
- "delete": {
- "flatPath": "v1/variantsets/{variantSetId}",
- "id": "genomics.variantsets.delete",
- "path": "v1/variantsets/{variantSetId}",
- "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "variantSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "variantSetId": {
- "location": "path",
- "description": "The ID of the variant set to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "create": {
- "flatPath": "v1/variantsets",
- "id": "genomics.variantsets.create",
- "path": "v1/variantsets",
- "request": {
- "$ref": "VariantSet"
- },
- "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "VariantSet"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- }
- }
- },
- "annotations": {
- "methods": {
- "delete": {
- "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "annotationId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "annotationId": {
- "description": "The ID of the annotation to be deleted.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.delete",
- "path": "v1/annotations/{annotationId}"
- },
- "create": {
- "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.",
- "request": {
- "$ref": "Annotation"
- },
- "response": {
- "$ref": "Annotation"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/annotations",
- "path": "v1/annotations",
- "id": "genomics.annotations.create"
- },
- "batchCreate": {
- "request": {
- "$ref": "BatchCreateAnnotationsRequest"
- },
- "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.",
- "response": {
- "$ref": "BatchCreateAnnotationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/annotations:batchCreate",
- "path": "v1/annotations:batchCreate",
- "id": "genomics.annotations.batchCreate"
- },
- "search": {
- "response": {
- "$ref": "SearchAnnotationsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/annotations/search",
- "path": "v1/annotations/search",
- "id": "genomics.annotations.search",
- "description": "Searches for annotations that match the given criteria. Results are\nordered by genomic coordinate (by reference sequence, then position).\nAnnotations with equivalent genomic coordinates are returned in an\nunspecified order. This order is consistent, such that two queries for the\nsame content (regardless of page size) yield annotations in the same order\nacross their respective streams of paginated responses. Caller must have\nREAD permission for the queried annotation sets.",
- "request": {
- "$ref": "SearchAnnotationsRequest"
- }
- },
- "get": {
- "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": {
- "location": "path",
- "description": "The ID of the annotation to be retrieved.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/annotations/{annotationId}",
- "path": "v1/annotations/{annotationId}",
- "id": "genomics.annotations.get",
- "description": "Gets an annotation. Caller must have READ permission\nfor the associated annotation set."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "annotationId"
- ],
- "response": {
- "$ref": "Annotation"
- },
- "parameters": {
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nvariant,\ntranscript, and\ninfo. If unspecified, all mutable\nfields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "annotationId": {
- "description": "The ID of the annotation to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "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}",
- "request": {
- "$ref": "Annotation"
- },
- "description": "Updates an annotation. Caller must have\nWRITE permission for the associated dataset."
- }
- }
- },
- "operations": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "pageSize": {
- "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- }
- },
- "flatPath": "v1/operations",
- "path": "v1/{+name}",
- "id": "genomics.operations.list",
- "description": "Lists operations that match the specified filter in the request."
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/operations/{operationsId}",
- "path": "v1/{+name}",
- "id": "genomics.operations.get"
- },
- "cancel": {
- "request": {
- "$ref": "CancelOperationRequest"
- },
- "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/operations/{operationsId}:cancel",
- "id": "genomics.operations.cancel",
- "path": "v1/{+name}:cancel"
- }
- }
- },
- "referencesets": {
- "methods": {
- "search": {
- "response": {
- "$ref": "SearchReferenceSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/referencesets/search",
- "path": "v1/referencesets/search",
- "id": "genomics.referencesets.search",
- "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)",
- "request": {
- "$ref": "SearchReferenceSetsRequest"
- }
- },
- "get": {
- "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": {
- "location": "path",
- "description": "The ID of the reference set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/referencesets/{referenceSetId}",
- "path": "v1/referencesets/{referenceSetId}",
- "id": "genomics.referencesets.get"
- }
- }
- },
- "callsets": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "callSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.delete",
- "path": "v1/callsets/{callSetId}",
- "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "search": {
- "response": {
- "$ref": "SearchCallSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/callsets/search",
- "path": "v1/callsets/search",
- "id": "genomics.callsets.search",
- "description": "Gets a list of call sets matching the criteria.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchCallSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L178).",
- "request": {
- "$ref": "SearchCallSetsRequest"
- }
- },
- "patch": {
- "description": "Updates a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.",
- "request": {
- "$ref": "CallSet"
- },
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "callSetId": {
- "description": "The ID of the call set to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.patch"
- },
- "get": {
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [
- "callSetId"
- ],
- "httpMethod": "GET",
- "parameters": {
- "callSetId": {
- "location": "path",
- "description": "The ID of the call set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/callsets/{callSetId}",
- "path": "v1/callsets/{callSetId}",
- "id": "genomics.callsets.get",
- "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "create": {
- "response": {
- "$ref": "CallSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "flatPath": "v1/callsets",
- "path": "v1/callsets",
- "id": "genomics.callsets.create",
- "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)"
- }
- }
- },
- "reads": {
- "methods": {
- "search": {
- "response": {
- "$ref": "SearchReadsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {},
- "flatPath": "v1/reads/search",
- "path": "v1/reads/search",
- "id": "genomics.reads.search",
- "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": {
- "methods": {
- "delete": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.delete",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "import": {
- "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)",
- "request": {
- "$ref": "ImportReadGroupSetsRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/readgroupsets:import",
- "id": "genomics.readgroupsets.import",
- "path": "v1/readgroupsets:import"
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "Required. The ID of the read group set to export. The caller must have\nREAD access to this read group set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}:export",
- "path": "v1/readgroupsets/{readGroupSetId}:export",
- "id": "genomics.readgroupsets.export"
- },
- "search": {
- "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).",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchReadGroupSetsResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "ReadGroupSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "parameters": {
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.get",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)"
- },
- "patch": {
- "flatPath": "v1/readgroupsets/{readGroupSetId}",
- "id": "genomics.readgroupsets.patch",
- "path": "v1/readgroupsets/{readGroupSetId}",
- "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"
- },
- "httpMethod": "PATCH",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "ReadGroupSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "updateMask": {
- "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "readGroupSetId": {
- "location": "path",
- "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.",
- "required": true,
- "type": "string"
- }
- }
- }
- },
- "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",
- "parameterOrder": [
- "readGroupSetId"
- ],
- "response": {
- "$ref": "ListCoverageBucketsResponse"
- },
- "parameters": {
- "referenceName": {
- "location": "query",
- "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.",
- "type": "string"
- },
- "end": {
- "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "pageToken": {
- "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024. The maximum value is 2048.",
- "format": "int32",
- "type": "integer"
- },
- "start": {
- "location": "query",
- "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified. Defaults to 0.",
- "format": "int64",
- "type": "string"
- },
- "targetBucketWidth": {
- "description": "The desired width of each reported coverage bucket in base pairs. This\nwill be rounded down to the nearest precomputed bucket width; the value\nof which is returned as `bucketWidth` in the response. Defaults\nto infinity (each bucket spans an entire reference sequence) or the length\nof the target range, if specified. The smallest precomputed\n`bucketWidth` is currently 2048 base pairs; this is subject to\nchange.",
- "format": "int64",
- "type": "string",
- "location": "query"
- },
- "readGroupSetId": {
- "description": "Required. The ID of the read group set over which coverage is requested.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets",
- "id": "genomics.readgroupsets.coveragebuckets.list",
- "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets"
- }
- }
- }
- }
- },
- "annotationsets": {
- "methods": {
- "search": {
- "request": {
- "$ref": "SearchAnnotationSetsRequest"
- },
- "description": "Searches for annotation sets that match the given criteria. Annotation sets\nare returned in an unspecified order. This order is consistent, such that\ntwo queries for the same content (regardless of page size) yield annotation\nsets in the same order across their respective streams of paginated\nresponses. Caller must have READ permission for the queried datasets.",
- "response": {
- "$ref": "SearchAnnotationSetsResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/annotationsets/search",
- "path": "v1/annotationsets/search",
- "id": "genomics.annotationsets.search"
- },
- "get": {
- "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.",
- "httpMethod": "GET",
- "parameterOrder": [
- "annotationSetId"
- ],
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameters": {
- "annotationSetId": {
- "description": "The ID of the annotation set to be retrieved.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ],
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.get",
- "path": "v1/annotationsets/{annotationSetId}"
- },
- "update": {
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.update",
- "request": {
- "$ref": "AnnotationSet"
- },
- "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.",
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "updateMask": {
- "description": "An optional mask specifying which fields to update. Mutable fields are\nname,\nsource_uri, and\ninfo. If unspecified, all\nmutable fields will be updated.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "annotationSetId": {
- "description": "The ID of the annotation set to be updated.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "create": {
- "flatPath": "v1/annotationsets",
- "path": "v1/annotationsets",
- "id": "genomics.annotationsets.create",
- "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).",
- "request": {
- "$ref": "AnnotationSet"
- },
- "response": {
- "$ref": "AnnotationSet"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {}
- },
- "delete": {
- "flatPath": "v1/annotationsets/{annotationSetId}",
- "path": "v1/annotationsets/{annotationSetId}",
- "id": "genomics.annotationsets.delete",
- "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "annotationSetId"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "annotationSetId": {
- "location": "path",
- "description": "The ID of the annotation set to be deleted.",
- "required": true,
- "type": "string"
- }
- }
- }
- }
- },
- "variants": {
- "methods": {
- "create": {
- "description": "Creates a new variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "request": {
- "$ref": "Variant"
- },
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {},
- "flatPath": "v1/variants",
- "path": "v1/variants",
- "id": "genomics.variants.create"
- },
- "search": {
- "flatPath": "v1/variants/search",
- "path": "v1/variants/search",
- "id": "genomics.variants.search",
- "request": {
- "$ref": "SearchVariantsRequest"
- },
- "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).",
- "response": {
- "$ref": "SearchVariantsResponse"
- },
- "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"
- ]
- },
- "patch": {
- "response": {
- "$ref": "Variant"
- },
- "parameterOrder": [
- "variantId"
- ],
- "httpMethod": "PATCH",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantId": {
- "location": "path",
- "description": "The ID of the variant to be updated.",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "location": "query",
- "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.patch",
- "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.",
- "request": {
- "$ref": "Variant"
- }
- },
- "get": {
- "flatPath": "v1/variants/{variantId}",
- "id": "genomics.variants.get",
- "path": "v1/variants/{variantId}",
- "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)",
- "httpMethod": "GET",
- "parameterOrder": [
- "variantId"
- ],
- "response": {
- "$ref": "Variant"
- },
- "parameters": {
- "variantId": {
- "description": "The ID of the variant.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics",
- "https://www.googleapis.com/auth/genomics.readonly"
- ]
- },
- "merge": {
- "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.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ]
- },
- "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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "variantId": {
- "location": "path",
- "description": "The ID of the variant to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/variants/{variantId}",
- "path": "v1/variants/{variantId}",
- "id": "genomics.variants.delete"
- },
- "import": {
- "flatPath": "v1/variants:import",
- "path": "v1/variants:import",
- "id": "genomics.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",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/devstorage.read_write",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {}
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- }
+ "batchPath": "batch"
}
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json
index f73673f..025d6f4 100644
--- a/genomics/v1alpha2/genomics-api.json
+++ b/genomics/v1alpha2/genomics-api.json
@@ -1,141 +1,39 @@
{
+ "revision": "20170309",
+ "documentationLink": "https://cloud.google.com/genomics",
+ "id": "genomics:v1alpha2",
+ "title": "Genomics API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
- "operations": {
- "methods": {
- "list": {
- "description": "Lists operations that match the specified filter in the request.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "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"
- },
- "name": {
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string",
- "pattern": "^operations$",
- "location": "path"
- },
- "pageToken": {
- "description": "The standard list page token.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v1alpha2/operations",
- "path": "v1alpha2/{+name}",
- "id": "genomics.operations.list"
- },
- "get": {
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha2/operations/{operationsId}",
- "id": "genomics.operations.get",
- "path": "v1alpha2/{+name}"
- },
- "cancel": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1alpha2/operations/{operationsId}:cancel",
- "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"
- }
- }
- }
- },
"pipelines": {
"methods": {
"get": {
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.get",
- "path": "v1alpha2/pipelines/{pipelineId}",
- "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.",
"httpMethod": "GET",
+ "response": {
+ "$ref": "Pipeline"
+ },
"parameterOrder": [
"pipelineId"
],
- "response": {
- "$ref": "Pipeline"
+ "parameters": {
+ "pipelineId": {
+ "location": "path",
+ "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
+ "required": true,
+ "type": "string"
+ }
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {
- "pipelineId": {
- "description": "Caller must have READ access to the project in which this pipeline\nis defined.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- }
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.get",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project."
},
"setOperationStatus": {
- "flatPath": "v1alpha2/pipelines:setOperationStatus",
- "path": "v1alpha2/pipelines:setOperationStatus",
- "id": "genomics.pipelines.setOperationStatus",
- "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
- "request": {
- "$ref": "SetOperationStatusRequest"
- },
"response": {
"$ref": "Empty"
},
@@ -145,21 +43,24 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
- "parameters": {}
+ "parameters": {},
+ "flatPath": "v1alpha2/pipelines:setOperationStatus",
+ "path": "v1alpha2/pipelines:setOperationStatus",
+ "id": "genomics.pipelines.setOperationStatus",
+ "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.",
+ "request": {
+ "$ref": "SetOperationStatusRequest"
+ }
},
"delete": {
"description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project.",
- "httpMethod": "DELETE",
"parameterOrder": [
"pipelineId"
],
+ "httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/genomics"
- ],
"parameters": {
"pipelineId": {
"location": "path",
@@ -168,47 +69,48 @@
"type": "string"
}
},
- "flatPath": "v1alpha2/pipelines/{pipelineId}",
- "id": "genomics.pipelines.delete",
- "path": "v1alpha2/pipelines/{pipelineId}"
- },
- "getControllerConfig": {
- "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users.",
- "response": {
- "$ref": "ControllerConfig"
- },
- "parameterOrder": [],
- "httpMethod": "GET",
- "parameters": {
- "operationId": {
- "location": "query",
- "description": "The operation to retrieve controller configuration for.",
- "type": "string"
- },
- "validationToken": {
- "location": "query",
- "format": "uint64",
- "type": "string"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/genomics"
],
+ "flatPath": "v1alpha2/pipelines/{pipelineId}",
+ "path": "v1alpha2/pipelines/{pipelineId}",
+ "id": "genomics.pipelines.delete"
+ },
+ "getControllerConfig": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ControllerConfig"
+ },
+ "parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "operationId": {
+ "description": "The operation to retrieve controller configuration for.",
+ "type": "string",
+ "location": "query"
+ },
+ "validationToken": {
+ "format": "uint64",
+ "type": "string",
+ "location": "query"
+ }
+ },
"flatPath": "v1alpha2/pipelines:getControllerConfig",
+ "id": "genomics.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."
},
"list": {
- "flatPath": "v1alpha2/pipelines",
- "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"
@@ -220,82 +122,238 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"projectId": {
+ "location": "query",
"description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.",
- "type": "string",
- "location": "query"
+ "type": "string"
}
- }
- },
- "create": {
+ },
"flatPath": "v1alpha2/pipelines",
"path": "v1alpha2/pipelines",
- "id": "genomics.pipelines.create",
+ "id": "genomics.pipelines.list"
+ },
+ "create": {
+ "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.",
"request": {
"$ref": "Pipeline"
},
- "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Pipeline"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
"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"
},
"run": {
- "request": {
- "$ref": "RunPipelineRequest"
- },
- "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
"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"
],
+ "parameters": {},
"flatPath": "v1alpha2/pipelines:run",
"id": "genomics.pipelines.run",
- "path": "v1alpha2/pipelines:run"
+ "path": "v1alpha2/pipelines:run",
+ "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.",
+ "request": {
+ "$ref": "RunPipelineRequest"
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "path": "v1alpha2/{+name}:cancel",
+ "id": "genomics.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1alpha2/operations/{operationsId}:cancel"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The standard list page token.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v1alpha2/operations",
+ "id": "genomics.operations.list",
+ "path": "v1alpha2/{+name}"
+ },
+ "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.",
+ "response": {
+ "$ref": "Operation"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/genomics"
+ ],
+ "flatPath": "v1alpha2/operations/{operationsId}"
}
}
}
},
"parameters": {
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
"location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
"type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
"location": "query"
},
"alt": {
@@ -313,65 +371,499 @@
"location": "query",
"description": "Data format for response.",
"default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
}
},
"schemas": {
- "SetOperationStatusRequest": {
- "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
+ "PipelineParameter": {
+ "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
"type": "object",
"properties": {
+ "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."
+ },
+ "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"
+ }
+ },
+ "id": "PipelineParameter"
+ },
+ "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"
+ },
+ "RunPipelineRequest": {
+ "properties": {
+ "pipelineArgs": {
+ "$ref": "RunPipelineArgs",
+ "description": "The arguments to use when running this pipeline."
+ },
+ "pipelineId": {
+ "description": "The already created pipeline to run.",
+ "type": "string"
+ },
+ "ephemeralPipeline": {
+ "description": "A new pipeline object to run once and then delete.",
+ "$ref": "Pipeline"
+ }
+ },
+ "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.",
+ "type": "object",
+ "properties": {},
+ "id": "CancelOperationRequest"
+ },
+ "RuntimeMetadata": {
+ "properties": {
+ "computeEngine": {
+ "$ref": "ComputeEngine",
+ "description": "Execution information specific to Google Compute Engine."
+ }
+ },
+ "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": {
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an empty response is returned.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`",
+ "type": "string"
+ },
+ "error": {
+ "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": "An OperationMetadata object. This will always be returned with the Operation.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ }
+ },
+ "id": "Operation"
+ },
+ "ImportReadGroupSetsResponse": {
+ "properties": {
+ "readGroupSetIds": {
+ "description": "IDs of the read group sets that were created.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ImportReadGroupSetsResponse",
+ "description": "The read group set import response.",
+ "type": "object"
+ },
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\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"
+ },
+ "ServiceAccount": {
+ "description": "A Google Cloud Service Account.",
+ "type": "object",
+ "properties": {
+ "email": {
+ "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project.",
+ "type": "string"
+ },
+ "scopes": {
+ "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ServiceAccount"
+ },
+ "PipelineResources": {
+ "properties": {
+ "preemptible": {
+ "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.",
+ "type": "boolean"
+ },
+ "minimumRamGb": {
+ "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
+ "format": "double",
+ "type": "number"
+ },
+ "zones": {
+ "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "minimumCpuCores": {
+ "description": "The minimum number of cores to use. Defaults to 1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "Disk"
+ }
+ },
+ "bootDiskSizeGb": {
+ "description": "The size of the boot disk. Defaults to 10 (GB).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PipelineResources",
+ "description": "The system resources for the pipeline run.",
+ "type": "object"
+ },
+ "Pipeline": {
+ "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.",
+ "type": "object",
+ "properties": {
+ "outputParameters": {
+ "description": "Output parameters of the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "PipelineParameter"
+ }
+ },
+ "docker": {
+ "$ref": "DockerExecutor",
+ "description": "Specifies the docker run information."
+ },
+ "description": {
+ "description": "User-specified description.",
+ "type": "string"
+ },
+ "inputParameters": {
+ "description": "Input parameters of the pipeline.",
+ "type": "array",
+ "items": {
+ "$ref": "PipelineParameter"
+ }
+ },
+ "resources": {
+ "$ref": "PipelineResources",
+ "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb"
+ },
+ "name": {
+ "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "id": "Pipeline"
+ },
+ "OperationEvent": {
+ "description": "An event that occurred during an Operation.",
+ "type": "object",
+ "properties": {
+ "endTime": {
+ "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Optional time of when event started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "description": {
+ "description": "Required description of event.",
+ "type": "string"
+ }
+ },
+ "id": "OperationEvent"
+ },
+ "ControllerConfig": {
+ "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.",
+ "type": "object",
+ "properties": {
+ "vars": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "image": {
+ "type": "string"
+ },
+ "gcsLogPath": {
+ "type": "string"
+ },
+ "gcsSources": {
+ "additionalProperties": {
+ "$ref": "RepeatedString"
+ },
+ "type": "object"
+ },
+ "gcsSinks": {
+ "additionalProperties": {
+ "$ref": "RepeatedString"
+ },
+ "type": "object"
+ },
+ "disks": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "machineType": {
+ "type": "string"
+ },
+ "cmd": {
+ "type": "string"
+ }
+ },
+ "id": "ControllerConfig"
+ },
+ "ListOperationsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ },
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
+ }
+ },
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object"
+ },
+ "RepeatedString": {
+ "properties": {
+ "values": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "RepeatedString",
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "description": "Metadata describing an Operation.",
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which the job stopped running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "events": {
+ "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
+ "type": "array",
+ "items": {
+ "$ref": "OperationEvent"
+ }
+ },
+ "startTime": {
+ "description": "The time at which the job began to run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "request": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "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": {
+ "description": "The time at which the job was submitted to the Genomics service.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The Google Cloud Project in which the job is scoped.",
+ "type": "string"
+ }
+ },
+ "id": "OperationMetadata"
+ },
+ "RunPipelineArgs": {
+ "description": "The pipeline run arguments.",
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "type": "object"
+ },
+ "logging": {
+ "$ref": "LoggingOptions",
+ "description": "Required. Logging options. Used by the service to communicate results\nto the user."
+ },
+ "keepVmAliveOnFailureDuration": {
+ "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "resources": {
+ "$ref": "PipelineResources",
+ "description": "Specifies resource requirements/overrides for the pipeline run."
+ },
+ "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.",
+ "type": "string"
+ },
+ "clientId": {
+ "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "$ref": "ServiceAccount",
+ "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used."
+ },
+ "inputs": {
+ "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"
+ }
+ },
+ "id": "RunPipelineArgs"
+ },
+ "ListPipelinesResponse": {
+ "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "The token to use to get the next page of results.",
+ "type": "string"
+ },
+ "pipelines": {
+ "description": "The matched pipelines.",
+ "type": "array",
+ "items": {
+ "$ref": "Pipeline"
+ }
+ }
+ },
+ "id": "ListPipelinesResponse"
+ },
+ "SetOperationStatusRequest": {
+ "properties": {
+ "operationId": {
+ "type": "string"
+ },
+ "errorMessage": {
+ "type": "string"
+ },
+ "validationToken": {
+ "format": "uint64",
+ "type": "string"
+ },
"errorCode": {
"enumDescriptions": [
"Not an error; returned on success\n\nHTTP Mapping: 200 OK",
@@ -418,32 +910,28 @@
"items": {
"$ref": "TimestampEvent"
}
- },
- "operationId": {
- "type": "string"
- },
- "errorMessage": {
- "type": "string"
- },
- "validationToken": {
- "format": "uint64",
- "type": "string"
}
},
- "id": "SetOperationStatusRequest"
+ "id": "SetOperationStatusRequest",
+ "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.",
+ "type": "object"
+ },
+ "ImportVariantsResponse": {
+ "properties": {
+ "callSetIds": {
+ "description": "IDs of the call sets created during the import.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ImportVariantsResponse",
+ "description": "The variant data import response.",
+ "type": "object"
},
"ComputeEngine": {
- "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
- "type": "object",
"properties": {
- "instanceName": {
- "description": "The instance on which the operation is running.",
- "type": "string"
- },
- "zone": {
- "description": "The availability zone in which the instance resides.",
- "type": "string"
- },
"machineType": {
"description": "The machine type of the instance.",
"type": "string"
@@ -454,27 +942,21 @@
"items": {
"type": "string"
}
+ },
+ "instanceName": {
+ "description": "The instance on which the operation is running.",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The availability zone in which the instance resides.",
+ "type": "string"
}
},
- "id": "ComputeEngine"
- },
- "ImportVariantsResponse": {
- "description": "The variant data import response.",
- "type": "object",
- "properties": {
- "callSetIds": {
- "description": "IDs of the call sets created during the import.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ImportVariantsResponse"
+ "id": "ComputeEngine",
+ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.",
+ "type": "object"
},
"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",
@@ -486,26 +968,26 @@
"type": "string"
}
},
- "id": "TimestampEvent"
+ "id": "TimestampEvent",
+ "description": "Stores the list of events and times they occured for major events in job\nexecution.",
+ "type": "object"
},
"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"
+ },
+ "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": "LocalCopy"
+ "id": "LocalCopy",
+ "description": "LocalCopy defines how a remote file should be copied to and from the VM.",
+ "type": "object"
},
"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.",
@@ -516,11 +998,11 @@
"type": "string"
}
},
- "id": "DockerExecutor"
+ "id": "DockerExecutor",
+ "description": "The Docker execuctor specification.",
+ "type": "object"
},
"Disk": {
- "description": "A Google Compute Engine disk resource specification.",
- "type": "object",
"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.",
@@ -544,8 +1026,6 @@
"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.",
@@ -557,514 +1037,40 @@
"PERSISTENT_HDD",
"PERSISTENT_SSD",
"LOCAL_SSD"
- ]
+ ],
+ "description": "Required. The type of the disk to create.",
+ "type": "string"
}
},
- "id": "Disk"
+ "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",
- "properties": {},
- "id": "Empty"
- },
- "PipelineParameter": {
- "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Human-readable description.",
- "type": "string"
- },
- "localCopy": {
- "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"
- },
- "defaultValue": {
- "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.",
- "type": "string"
- },
- "name": {
- "description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.",
- "type": "string"
- }
- },
- "id": "PipelineParameter"
- },
- "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"
- },
- "RunPipelineRequest": {
- "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.",
- "type": "object",
- "properties": {
- "pipelineId": {
- "description": "The already created pipeline to run.",
- "type": "string"
- },
- "ephemeralPipeline": {
- "description": "A new pipeline object to run once and then delete.",
- "$ref": "Pipeline"
- },
- "pipelineArgs": {
- "$ref": "RunPipelineArgs",
- "description": "The arguments to use when running this pipeline."
- }
- },
- "id": "RunPipelineRequest"
- },
- "CancelOperationRequest": {
- "description": "The request message for Operations.CancelOperation.",
- "type": "object",
- "properties": {},
- "id": "CancelOperationRequest"
- },
- "RuntimeMetadata": {
- "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.",
- "type": "object",
- "properties": {
- "computeEngine": {
- "$ref": "ComputeEngine",
- "description": "Execution information specific to Google Compute Engine."
- }
- },
- "id": "RuntimeMetadata"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ImportReadGroupSetsResponse"
- },
- "Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- }
- },
- "id": "Status"
- },
- "ServiceAccount": {
- "description": "A Google Cloud Service Account.",
- "type": "object",
- "properties": {
- "email": {
- "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project.",
- "type": "string"
- },
- "scopes": {
- "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "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.\n** Note: To use this option, your project must be in Google Access for\nPrivate IPs Early Access Program.**",
- "type": "boolean"
- },
- "disks": {
- "description": "Disks to attach.",
- "type": "array",
- "items": {
- "$ref": "Disk"
- }
- },
- "bootDiskSizeGb": {
- "description": "The size of the boot disk. Defaults to 10 (GB).",
- "format": "int32",
- "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": {
- "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)",
- "format": "double",
- "type": "number"
- },
- "zones": {
- "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "minimumCpuCores": {
- "description": "The minimum number of cores to use. Defaults to 1.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "PipelineResources"
- },
- "Pipeline": {
- "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.",
- "type": "object",
- "properties": {
- "resources": {
- "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"
- },
- "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.",
- "type": "array",
- "items": {
- "$ref": "PipelineParameter"
- }
- },
- "docker": {
- "$ref": "DockerExecutor",
- "description": "Specifies the docker run information."
- },
- "description": {
- "description": "User-specified description.",
- "type": "string"
- },
- "inputParameters": {
- "description": "Input parameters of the pipeline.",
- "type": "array",
- "items": {
- "$ref": "PipelineParameter"
- }
- }
- },
- "id": "Pipeline"
- },
- "ControllerConfig": {
- "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.",
- "type": "object",
- "properties": {
- "gcsSources": {
- "additionalProperties": {
- "$ref": "RepeatedString"
- },
- "type": "object"
- },
- "gcsSinks": {
- "type": "object",
- "additionalProperties": {
- "$ref": "RepeatedString"
- }
- },
- "disks": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "machineType": {
- "type": "string"
- },
- "cmd": {
- "type": "string"
- },
- "vars": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "image": {
- "type": "string"
- },
- "gcsLogPath": {
- "type": "string"
- }
- },
- "id": "ControllerConfig"
- },
- "OperationEvent": {
- "description": "An event that occurred during an Operation.",
- "type": "object",
- "properties": {
- "description": {
- "description": "Required description of event.",
- "type": "string"
- },
- "endTime": {
- "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Optional time of when event started.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationEvent"
- },
- "RepeatedString": {
- "type": "object",
- "properties": {
- "values": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "RepeatedString"
- },
- "ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "ListOperationsResponse"
- },
- "OperationMetadata": {
- "description": "Metadata describing an Operation.",
- "type": "object",
- "properties": {
- "request": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The original request that started the operation. 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": {
- "description": "The time at which the job was submitted to the Genomics service.",
- "format": "google-datetime",
- "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"
- },
- "events": {
- "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.",
- "type": "array",
- "items": {
- "$ref": "OperationEvent"
- }
- },
- "endTime": {
- "description": "The time at which the job stopped running.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The time at which the job began to run.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "OperationMetadata"
- },
- "RunPipelineArgs": {
- "description": "The pipeline run arguments.",
- "type": "object",
- "properties": {
- "projectId": {
- "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.",
- "type": "string"
- },
- "clientId": {
- "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.",
- "type": "string"
- },
- "serviceAccount": {
- "$ref": "ServiceAccount",
- "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used."
- },
- "inputs": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.",
- "type": "object"
- },
- "labels": {
- "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "logging": {
- "$ref": "LoggingOptions",
- "description": "Required. Logging options. Used by the service to communicate results\nto the user."
- },
- "keepVmAliveOnFailureDuration": {
- "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.",
- "format": "google-duration",
- "type": "string"
- },
- "resources": {
- "description": "Specifies resource requirements/overrides for the pipeline run.",
- "$ref": "PipelineResources"
- },
- "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"
- }
- }
- },
- "id": "RunPipelineArgs"
- },
- "ListPipelinesResponse": {
- "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token to use to get the next page of results.",
- "type": "string"
- },
- "pipelines": {
- "description": "The matched pipelines.",
- "type": "array",
- "items": {
- "$ref": "Pipeline"
- }
- }
- },
- "id": "ListPipelinesResponse"
+ "type": "object"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"version": "v1alpha2",
"baseUrl": "https://genomics.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ },
"https://www.googleapis.com/auth/genomics": {
"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"
}
}
}
@@ -1076,11 +1082,5 @@
"basePath": "",
"ownerDomain": "google.com",
"name": "genomics",
- "batchPath": "batch",
- "revision": "20170306",
- "id": "genomics:v1alpha2",
- "documentationLink": "https://cloud.google.com/genomics",
- "title": "Genomics API",
- "discoveryVersion": "v1",
- "ownerName": "Google"
+ "batchPath": "batch"
}
diff --git a/genomics/v1alpha2/genomics-gen.go b/genomics/v1alpha2/genomics-gen.go
index 5a178a7..8168ca7 100644
--- a/genomics/v1alpha2/genomics-gen.go
+++ b/genomics/v1alpha2/genomics-gen.go
@@ -984,9 +984,10 @@
// may
// only load docker images from Google Container Registry and not Docker
// Hub.
- // ** Note: To use this option, your project must be in Google Access
- // for
- // Private IPs Early Access Program.**
+ // Before using this, you must
+ // [configure access to Google services from internal
+ // IPs](https://cloud.google.com/compute/docs/configure-private-google-ac
+ // cess#configuring_access_to_google_services_from_internal_ips).
NoAddress bool `json:"noAddress,omitempty"`
// Preemptible: Whether to use preemptible VMs. Defaults to `false`. In
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json
index 91ec01c..d6f5486 100644
--- a/iam/v1/iam-api.json
+++ b/iam/v1/iam-api.json
@@ -1,46 +1,210 @@
{
+ "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",
+ "title": "Google Identity and Access Management (IAM) API",
"ownerName": "Google",
"resources": {
+ "roles": {
+ "methods": {
+ "queryGrantableRoles": {
+ "id": "iam.roles.queryGrantableRoles",
+ "path": "v1/roles:queryGrantableRoles",
+ "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.",
+ "request": {
+ "$ref": "QueryGrantableRolesRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "QueryGrantableRolesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/roles:queryGrantableRoles"
+ }
+ }
+ },
"projects": {
"resources": {
"serviceAccounts": {
+ "resources": {
+ "keys": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.keys.delete",
+ "description": "Deletes a ServiceAccountKey."
+ },
+ "list": {
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.list",
+ "description": "Lists ServiceAccountKeys.",
+ "response": {
+ "$ref": "ListServiceAccountKeysResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "keyTypes": {
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "KEY_TYPE_UNSPECIFIED",
+ "USER_MANAGED",
+ "SYSTEM_MANAGED"
+ ],
+ "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nUsing `-` as a wildcard for the project, will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
+ },
+ "get": {
+ "description": "Gets the ServiceAccountKey\nby key id.",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "publicKeyType": {
+ "location": "query",
+ "enum": [
+ "TYPE_NONE",
+ "TYPE_X509_PEM_FILE",
+ "TYPE_RAW_PUBLIC_KEY"
+ ],
+ "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\n\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
+ "id": "iam.projects.serviceAccounts.keys.get",
+ "path": "v1/{+name}"
+ },
+ "create": {
+ "path": "v1/{+name}/keys",
+ "id": "iam.projects.serviceAccounts.keys.create",
+ "request": {
+ "$ref": "CreateServiceAccountKeyRequest"
+ },
+ "description": "Creates a ServiceAccountKey\nand returns it.",
+ "response": {
+ "$ref": "ServiceAccountKey"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys"
+ }
+ }
+ }
+ },
"methods": {
- "testIamPermissions": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "iam.projects.serviceAccounts.testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
+ "getIamPolicy": {
+ "description": "Returns the IAM access control policy for a\nServiceAccount.",
+ "httpMethod": "POST",
"response": {
- "$ref": "TestIamPermissionsResponse"
+ "$ref": "Policy"
},
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
"parameters": {
"resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`."
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
+ "id": "iam.projects.serviceAccounts.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy"
},
- "delete": {
+ "get": {
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"parameterOrder": [
"name"
],
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
+ "httpMethod": "GET",
"parameters": {
"name": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
@@ -55,24 +219,136 @@
],
"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
"path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.delete",
- "description": "Deletes a ServiceAccount."
+ "id": "iam.projects.serviceAccounts.get",
+ "description": "Gets a ServiceAccount."
},
- "list": {
+ "update": {
+ "response": {
+ "$ref": "ServiceAccount"
+ },
"parameterOrder": [
"name"
],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nRequests using `-` as a wildcard for the project will infer the project\nfrom the `account` and the `account` value can be the `email` address or\nthe `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "path": "v1/{+name}",
+ "id": "iam.projects.serviceAccounts.update",
+ "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
+ "request": {
+ "$ref": "ServiceAccount"
+ }
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "iam.projects.serviceAccounts.testIamPermissions",
+ "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ }
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
+ "id": "iam.projects.serviceAccounts.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a ServiceAccount."
+ },
+ "signBlob": {
+ "path": "v1/{+name}:signBlob",
+ "id": "iam.projects.serviceAccounts.signBlob",
+ "description": "Signs a blob using a service account's system-managed private key.",
+ "request": {
+ "$ref": "SignBlobRequest"
+ },
+ "response": {
+ "$ref": "SignBlobResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob"
+ },
+ "list": {
+ "httpMethod": "GET",
"response": {
"$ref": "ListServiceAccountsResponse"
},
- "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
"name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"pageToken": {
"location": "query",
@@ -86,70 +362,11 @@
"location": "query"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "path": "v1/{+name}/serviceAccounts",
"id": "iam.projects.serviceAccounts.list",
+ "path": "v1/{+name}/serviceAccounts",
"description": "Lists ServiceAccounts for a project."
},
- "signBlob": {
- "response": {
- "$ref": "SignBlobResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account."
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob",
- "path": "v1/{+name}:signBlob",
- "id": "iam.projects.serviceAccounts.signBlob",
- "description": "Signs a blob using a service account's system-managed private key.",
- "request": {
- "$ref": "SignBlobRequest"
- }
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the IAM access control policy for a\nServiceAccount.",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "iam.projects.serviceAccounts.setIamPolicy"
- },
"signJwt": {
"response": {
"$ref": "SignJwtResponse"
@@ -179,10 +396,12 @@
}
},
"create": {
+ "id": "iam.projects.serviceAccounts.create",
+ "path": "v1/{+name}/serviceAccounts",
+ "description": "Creates a ServiceAccount\nand returns it.",
"request": {
"$ref": "CreateServiceAccountRequest"
},
- "description": "Creates a ServiceAccount\nand returns it.",
"httpMethod": "POST",
"parameterOrder": [
"name"
@@ -190,33 +409,31 @@
"response": {
"$ref": "ServiceAccount"
},
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`."
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts",
- "id": "iam.projects.serviceAccounts.create",
- "path": "v1/{+name}/serviceAccounts"
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts"
},
- "getIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "iam.projects.serviceAccounts.getIamPolicy",
- "description": "Returns the IAM access control policy for a\nServiceAccount.",
- "parameterOrder": [
- "resource"
- ],
+ "setIamPolicy": {
+ "description": "Sets the IAM access control policy for a\nServiceAccount.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
"response": {
"$ref": "Policy"
},
+ "parameterOrder": [
+ "resource"
+ ],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
@@ -225,220 +442,18 @@
"resource": {
"pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
"location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccount"
- },
- "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/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}",
- "id": "iam.projects.serviceAccounts.get",
- "path": "v1/{+name}",
- "description": "Gets a ServiceAccount."
- },
- "update": {
- "id": "iam.projects.serviceAccounts.update",
- "path": "v1/{+name}",
- "request": {
- "$ref": "ServiceAccount"
- },
- "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccount"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path",
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nRequests using `-` as a wildcard for the project will infer the project\nfrom the `account` and the `account` value can be the `email` address or\nthe `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.",
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}"
- }
- },
- "resources": {
- "keys": {
- "methods": {
- "delete": {
- "description": "Deletes a ServiceAccountKey.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.delete"
- },
- "list": {
- "description": "Lists ServiceAccountKeys.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListServiceAccountKeysResponse"
- },
- "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/{SERVICE_ACCOUNT_EMAIL}`.\n\nUsing `-` as a wildcard for the project, will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- },
- "keyTypes": {
- "location": "query",
- "enum": [
- "KEY_TYPE_UNSPECIFIED",
- "USER_MANAGED",
- "SYSTEM_MANAGED"
- ],
- "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.",
- "type": "string",
- "repeated": true
- }
- },
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys",
- "id": "iam.projects.serviceAccounts.keys.list",
- "path": "v1/{+name}/keys"
- },
- "get": {
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "publicKeyType": {
- "description": "The output format of the public key requested.\nX509_PEM is the default output format.",
- "type": "string",
- "location": "query",
- "enum": [
- "TYPE_NONE",
- "TYPE_X509_PEM_FILE",
- "TYPE_RAW_PUBLIC_KEY"
- ]
- },
- "name": {
- "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.\n\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}",
- "path": "v1/{+name}",
- "id": "iam.projects.serviceAccounts.keys.get",
- "description": "Gets the ServiceAccountKey\nby key id."
- },
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ServiceAccountKey"
- },
- "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/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$",
- "location": "path"
- }
- }
- }
- }
+ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "iam.projects.serviceAccounts.setIamPolicy"
}
}
}
}
- },
- "roles": {
- "methods": {
- "queryGrantableRoles": {
- "response": {
- "$ref": "QueryGrantableRolesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/roles:queryGrantableRoles",
- "path": "v1/roles:queryGrantableRoles",
- "id": "iam.roles.queryGrantableRoles",
- "request": {
- "$ref": "QueryGrantableRolesRequest"
- },
- "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource."
- }
- }
}
},
"parameters": {
@@ -453,23 +468,17 @@
"default": "true",
"location": "query"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "callback": {
- "description": "JSONP",
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
- "location": "query",
"enum": [
"1",
"2"
@@ -479,15 +488,15 @@
"enumDescriptions": [
"v1 error format",
"v2 error format"
- ]
+ ],
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
"alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -495,17 +504,23 @@
"media",
"proto"
],
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
"type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
"location": "query"
},
"key": {
+ "location": "query",
"description": "API key. Your API 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",
@@ -513,208 +528,34 @@
"type": "string"
},
"pp": {
+ "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
- "location": "query",
- "description": "Pretty-print response."
+ "location": "query"
},
"oauth_token": {
- "type": "string",
"location": "query",
- "description": "OAuth 2.0 token for the current user."
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
"baseUrl": "https://iam.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
"servicePath": "",
+ "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.",
+ "kind": "discovery#restDescription",
"basePath": "",
- "documentationLink": "https://cloud.google.com/iam/",
"revision": "20170217",
"id": "iam:v1",
+ "documentationLink": "https://cloud.google.com/iam/",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "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": {
- "keyAlgorithm": {
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ],
- "description": "Specifies the algorithm (and possibly key size) for the key.",
- "type": "string"
- },
- "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."
- ]
- },
- "validAfterTime": {
- "description": "The key can be used after this timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "privateKeyData": {
- "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses.",
- "format": "byte",
- "type": "string"
- },
- "publicKeyData": {
- "type": "string",
- "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
- "format": "byte"
- },
- "name": {
- "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.",
- "type": "string"
- },
- "validBeforeTime": {
- "description": "The key can be used before this timestamp.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "ServiceAccountKey"
- },
- "CreateServiceAccountKeyRequest": {
- "description": "The service account key create request.",
- "type": "object",
- "properties": {
- "keyAlgorithm": {
- "description": "Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified key algorithm.",
- "1k RSA Key.",
- "2k RSA Key."
- ],
- "enum": [
- "KEY_ALG_UNSPECIFIED",
- "KEY_ALG_RSA_1024",
- "KEY_ALG_RSA_2048"
- ]
- },
- "privateKeyType": {
- "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"
- },
- "TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest"
- },
- "SignBlobResponse": {
- "id": "SignBlobResponse",
- "description": "The service account sign blob response.",
- "type": "object",
- "properties": {
- "signature": {
- "description": "The signed blob.",
- "format": "byte",
- "type": "string"
- },
- "keyId": {
- "description": "The id of the key used to sign the blob.",
- "type": "string"
- }
- }
- },
- "SignJwtResponse": {
- "description": "The service account sign JWT response.",
- "type": "object",
- "properties": {
- "keyId": {
- "description": "The id of the key used to sign the JWT.",
- "type": "string"
- },
- "signedJwt": {
- "description": "The signed JWT.",
- "type": "string"
- }
- },
- "id": "SignJwtResponse"
- },
- "SignJwtRequest": {
- "type": "object",
- "properties": {
- "payload": {
- "description": "The JWT payload to sign, a JSON JWT Claim set.",
- "type": "string"
- }
- },
- "id": "SignJwtRequest",
- "description": "The service account sign JWT request."
- },
- "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`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Policy"
- },
"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",
@@ -730,6 +571,20 @@
"description": "One delta entry for Binding. Each individual change (only one member in each\nentry) to a binding will be a separate entry.",
"type": "object",
"properties": {
+ "action": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Addition of a Binding.",
+ "Removal of a Binding."
+ ],
+ "enum": [
+ "ACTION_UNSPECIFIED",
+ "ADD",
+ "REMOVE"
+ ],
+ "description": "The action that was performed on a Binding.\nRequired",
+ "type": "string"
+ },
"member": {
"description": "A single identity requesting access for a Cloud Platform resource.\nFollows the same format of Binding.members.\nRequired",
"type": "string"
@@ -737,25 +592,13 @@
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
"type": "string"
- },
- "action": {
- "enum": [
- "ACTION_UNSPECIFIED",
- "ADD",
- "REMOVE"
- ],
- "description": "The action that was performed on a Binding.\nRequired",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Addition of a Binding.",
- "Removal of a Binding."
- ]
}
},
"id": "BindingDelta"
},
"PolicyDelta": {
+ "description": "The difference delta between two policies.",
+ "type": "object",
"properties": {
"bindingDeltas": {
"description": "The delta for Bindings between two policies.",
@@ -765,27 +608,9 @@
}
}
},
- "id": "PolicyDelta",
- "description": "The difference delta between two policies.",
- "type": "object"
- },
- "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": {
- "type": "string",
- "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."
- }
- },
- "id": "CreateServiceAccountRequest"
+ "id": "PolicyDelta"
},
"ListServiceAccountsResponse": {
- "id": "ListServiceAccountsResponse",
"description": "The service account list response.",
"type": "object",
"properties": {
@@ -800,10 +625,25 @@
"$ref": "ServiceAccount"
}
}
- }
+ },
+ "id": "ListServiceAccountsResponse"
+ },
+ "CreateServiceAccountRequest": {
+ "properties": {
+ "serviceAccount": {
+ "$ref": "ServiceAccount",
+ "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ."
+ },
+ "accountId": {
+ "description": "Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.",
+ "type": "string"
+ }
+ },
+ "id": "CreateServiceAccountRequest",
+ "description": "The service account create request.",
+ "type": "object"
},
"QueryGrantableRolesResponse": {
- "type": "object",
"properties": {
"roles": {
"description": "The list of matching roles.",
@@ -814,7 +654,8 @@
}
},
"id": "QueryGrantableRolesResponse",
- "description": "The grantable role query response."
+ "description": "The grantable role query response.",
+ "type": "object"
},
"SignBlobRequest": {
"description": "The service account sign blob request.",
@@ -833,16 +674,16 @@
"type": "object",
"properties": {
"title": {
- "type": "string",
- "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes."
+ "description": "Optional. A human-readable title for the role. Typically this\nis limited to 100 UTF-8 bytes.",
+ "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"
},
"description": {
- "type": "string",
- "description": "Optional. A human-readable description for the role."
+ "description": "Optional. A human-readable description for the role.",
+ "type": "string"
}
},
"id": "Role"
@@ -880,43 +721,43 @@
"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/{SERVICE_ACCOUNT_EMAIL}. 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/{SERVICE_ACCOUNT_EMAIL}`.\nUsing `-` as a wildcard for the project will infer the project from\nthe account. The `account` value can be the `email` address or the\n`unique_id` of the service account.",
"type": "object",
"properties": {
- "etag": {
- "description": "Used to perform a consistent read-modify-write.",
- "format": "byte",
- "type": "string"
- },
- "email": {
- "description": "@OutputOnly The email address of the service account.",
- "type": "string"
- },
- "name": {
- "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nRequests using `-` as a wildcard for the project will infer the project\nfrom the `account` and the `account` value can be the `email` address or\nthe `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.",
- "type": "string"
- },
- "projectId": {
- "description": "@OutputOnly The id of the project that owns the service account.",
+ "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"
},
- "oauth2ClientId": {
- "description": "@OutputOnly. The OAuth2 client id for the service account.\nThis is used in conjunction with the OAuth2 clientconfig API to make\nthree legged OAuth2 (3LO) flows to access the data of Google users.",
- "type": "string"
- },
"displayName": {
"description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.",
"type": "string"
+ },
+ "etag": {
+ "description": "Used to perform a consistent read-modify-write.",
+ "format": "byte",
+ "type": "string"
+ },
+ "name": {
+ "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.\n\nRequests using `-` as a wildcard for the project will infer the project\nfrom the `account` and the `account` value can be the `email` address or\nthe `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.",
+ "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"
}
},
"id": "ServiceAccount"
},
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
},
"QueryGrantableRolesRequest": {
"description": "The grantable role query request.",
@@ -944,38 +785,197 @@
"type": "object"
},
"ListServiceAccountKeysResponse": {
- "id": "ListServiceAccountKeysResponse",
- "description": "The service account keys list response.",
- "type": "object",
"properties": {
"keys": {
+ "description": "The public keys for the service account.",
"type": "array",
"items": {
"$ref": "ServiceAccountKey"
- },
- "description": "The public keys for the service account."
+ }
}
- }
+ },
+ "id": "ListServiceAccountKeysResponse",
+ "description": "The service account keys list response.",
+ "type": "object"
+ },
+ "ServiceAccountKey": {
+ "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.",
+ "type": "string"
+ },
+ "validBeforeTime": {
+ "description": "The key can be used before this timestamp.",
+ "format": "google-datetime",
+ "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."
+ ]
+ },
+ "privateKeyType": {
+ "enumDescriptions": [
+ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.",
+ "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.",
+ "Google Credentials File format."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "TYPE_PKCS12_FILE",
+ "TYPE_GOOGLE_CREDENTIALS_FILE"
+ ],
+ "description": "The output format 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"
+ },
+ "validAfterTime": {
+ "description": "The key can be used after this timestamp.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "privateKeyData": {
+ "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses.",
+ "format": "byte",
+ "type": "string"
+ },
+ "publicKeyData": {
+ "description": "The public key data. Only provided in `GetServiceAccountKey` responses.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ServiceAccountKey"
+ },
+ "CreateServiceAccountKeyRequest": {
+ "properties": {
+ "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."
+ ]
+ },
+ "keyAlgorithm": {
+ "enum": [
+ "KEY_ALG_UNSPECIFIED",
+ "KEY_ALG_RSA_1024",
+ "KEY_ALG_RSA_2048"
+ ],
+ "description": "Which type of key and algorithm to use for the key.\nThe default is currently a 2K RSA key. However this may change in the\nfuture.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified key algorithm.",
+ "1k RSA Key.",
+ "2k RSA Key."
+ ]
+ }
+ },
+ "id": "CreateServiceAccountKeyRequest",
+ "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).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "SignBlobResponse": {
+ "properties": {
+ "keyId": {
+ "description": "The id of the key used to sign the blob.",
+ "type": "string"
+ },
+ "signature": {
+ "description": "The signed blob.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "SignBlobResponse",
+ "description": "The service account sign blob response.",
+ "type": "object"
+ },
+ "SignJwtResponse": {
+ "description": "The service account sign JWT response.",
+ "type": "object",
+ "properties": {
+ "keyId": {
+ "description": "The id of the key used to sign the JWT.",
+ "type": "string"
+ },
+ "signedJwt": {
+ "description": "The signed JWT.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtResponse"
+ },
+ "SignJwtRequest": {
+ "properties": {
+ "payload": {
+ "description": "The JWT payload to sign, a JSON JWT Claim set.",
+ "type": "string"
+ }
+ },
+ "id": "SignJwtRequest",
+ "description": "The service account sign JWT request.",
+ "type": "object"
+ },
+ "Policy": {
+ "properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ },
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object"
}
},
- "protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
- "canonicalName": "iam",
- "auth": {
- "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",
- "title": "Google Identity and Access Management (IAM) API"
+ "protocol": "rest"
}
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json
index 8e87183..f21d9bf 100644
--- a/kgsearch/v1/kgsearch-api.json
+++ b/kgsearch/v1/kgsearch-api.json
@@ -1,5 +1,4 @@
{
- "title": "Knowledge Graph Search API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": "True",
@@ -7,67 +6,111 @@
"entities": {
"methods": {
"search": {
- "httpMethod": "GET",
- "parameterOrder": [],
"response": {
"$ref": "SearchResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
- "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",
+ "types": {
+ "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
"type": "string",
"repeated": true,
"location": "query"
},
- "limit": {
+ "indent": {
+ "description": "Enables indenting of json results.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "languages": {
+ "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "ids": {
+ "repeated": true,
"location": "query",
+ "description": "The list of entity id to be used for search instead of query string.\nTo specify multiple ids in the HTTP request, repeat the parameter in the\nURL as in ...?ids=A&ids=B",
+ "type": "string"
+ },
+ "limit": {
"description": "Limits the number of entities to be returned.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"prefix": {
- "type": "boolean",
"location": "query",
- "description": "Enables prefix match against names and aliases of entities"
+ "description": "Enables prefix match against names and aliases of entities",
+ "type": "boolean"
},
"query": {
"location": "query",
"description": "The literal query string for search.",
"type": "string"
- },
- "types": {
- "repeated": true,
- "location": "query",
- "description": "Restricts returned entities with these types, e.g. Person\n(as defined in http://schema.org/Person). If multiple types are specified,\nreturned entities will contain one or more of these types.",
- "type": "string"
- },
- "indent": {
- "location": "query",
- "description": "Enables indenting of json results.",
- "type": "boolean"
- },
- "languages": {
- "location": "query",
- "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.",
- "type": "string",
- "repeated": true
}
},
"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"
}
}
}
},
"parameters": {
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -76,7 +119,12 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"access_token": {
"description": "OAuth access token.",
@@ -89,68 +137,20 @@
"location": "query"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "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": {
- "type": "boolean",
"default": "true",
- "location": "query",
- "description": "Returns response with indentations and line breaks."
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
"location": "query"
- },
- "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"
}
},
"schemas": {
"SearchResponse": {
+ "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.",
"type": "object",
"properties": {
"@context": {
@@ -158,25 +158,24 @@
"type": "any"
},
"itemListElement": {
+ "description": "The item list of search results.",
"type": "array",
"items": {
"type": "any"
- },
- "description": "The item list of search results."
+ }
},
"@type": {
- "type": "any",
- "description": "The schema type of top-level JSON-LD object, e.g. ItemList."
+ "description": "The schema type of top-level JSON-LD object, e.g. ItemList.",
+ "type": "any"
}
},
- "id": "SearchResponse",
- "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities."
+ "id": "SearchResponse"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"version": "v1",
"baseUrl": "https://kgsearch.googleapis.com/",
@@ -190,5 +189,6 @@
"batchPath": "batch",
"revision": "20170109",
"documentationLink": "https://developers.google.com/knowledge-graph/",
- "id": "kgsearch:v1"
+ "id": "kgsearch:v1",
+ "title": "Knowledge Graph Search API"
}
diff --git a/language/v1/language-api.json b/language/v1/language-api.json
index d4d503a..061f79a 100644
--- a/language/v1/language-api.json
+++ b/language/v1/language-api.json
@@ -1,6 +1,6 @@
{
- "description": "Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, and text annotations.",
"kind": "discovery#restDescription",
+ "description": "Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, and text annotations.",
"servicePath": "",
"basePath": "",
"documentationLink": "https://cloud.google.com/natural-language/",
@@ -9,124 +9,32 @@
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity analysis request message.",
"type": "object",
"properties": {
- "details": {
- "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
},
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "Features": {
- "type": "object",
- "properties": {
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
- },
- "extractSyntax": {
- "description": "Extract syntax information.",
- "type": "boolean"
- },
- "extractDocumentSentiment": {
- "type": "boolean",
- "description": "Extract document-level sentiment."
- }
- },
- "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."
- },
- "EntityMention": {
- "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
- "type": "object",
- "properties": {
- "text": {
- "$ref": "TextSpan",
- "description": "The mention text."
- },
- "type": {
- "description": "The type of the entity mention.",
- "type": "string",
+ "encodingType": {
"enumDescriptions": [
- "Unknown",
- "Proper name",
- "Common noun (or noun compound)"
+ "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": [
- "TYPE_UNKNOWN",
- "PROPER",
- "COMMON"
- ]
- }
- },
- "id": "EntityMention"
- },
- "Document": {
- "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**Current Language Restrictions:**\n\n * Only English, Spanish, and Japanese textual content are supported.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
- "type": "string"
- },
- "type": {
- "enumDescriptions": [
- "The content type is not specified.",
- "Plain text",
- "HTML"
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
],
- "enum": [
- "TYPE_UNSPECIFIED",
- "PLAIN_TEXT",
- "HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string"
- },
- "content": {
- "description": "The content of the input in string format.",
+ "description": "The encoding type used by the API to calculate offsets.",
"type": "string"
}
},
- "id": "Document",
- "description": "################################################################ #\n\nRepresents the input to API methods."
- },
- "Sentence": {
- "description": "Represents a sentence in the input document.",
- "type": "object",
- "properties": {
- "text": {
- "$ref": "TextSpan",
- "description": "The sentence text."
- },
- "sentiment": {
- "$ref": "Sentiment",
- "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence."
- }
- },
- "id": "Sentence"
+ "id": "AnalyzeEntitiesRequest"
},
"Sentiment": {
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
@@ -145,52 +53,199 @@
},
"id": "Sentiment"
},
- "AnalyzeEntitiesRequest": {
- "description": "The entity analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ]
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
- }
- },
- "id": "AnalyzeEntitiesRequest"
- },
"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": {
- "enum": [
- "PROPER_UNKNOWN",
- "PROPER",
- "NOT_PROPER"
+ "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": {
+ "description": "The grammatical number.",
+ "type": "string",
+ "enumDescriptions": [
+ "Number is not applicable in the analyzed language or is not predicted.",
+ "Singular",
+ "Plural",
+ "Dual"
+ ],
+ "enum": [
+ "NUMBER_UNKNOWN",
+ "SINGULAR",
+ "PLURAL",
+ "DUAL"
+ ]
+ },
+ "voice": {
+ "enumDescriptions": [
+ "Voice is not applicable in the analyzed language or is not predicted.",
+ "Active",
+ "Causative",
+ "Passive"
+ ],
+ "enum": [
+ "VOICE_UNKNOWN",
+ "ACTIVE",
+ "CAUSATIVE",
+ "PASSIVE"
+ ],
+ "description": "The grammatical voice.",
+ "type": "string"
+ },
+ "aspect": {
+ "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": {
+ "enumDescriptions": [
+ "Unknown",
+ "Adjective",
+ "Adposition (preposition and postposition)",
+ "Adverb",
+ "Conjunction",
+ "Determiner",
+ "Noun (common and proper)",
+ "Cardinal number",
+ "Pronoun",
+ "Particle or other function word",
+ "Punctuation",
+ "Verb (all tenses and modes)",
+ "Other: foreign words, typos, abbreviations",
+ "Affix"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ADJ",
+ "ADP",
+ "ADV",
+ "CONJ",
+ "DET",
+ "NOUN",
+ "NUM",
+ "PRON",
+ "PRT",
+ "PUNCT",
+ "VERB",
+ "X",
+ "AFFIX"
+ ],
+ "description": "The part of speech tag.",
+ "type": "string"
+ },
+ "gender": {
+ "enumDescriptions": [
+ "Gender is not applicable in the analyzed language or is not predicted.",
+ "Feminine",
+ "Masculine",
+ "Neuter"
+ ],
+ "enum": [
+ "GENDER_UNKNOWN",
+ "FEMININE",
+ "MASCULINE",
+ "NEUTER"
+ ],
+ "description": "The grammatical gender.",
+ "type": "string"
+ },
+ "person": {
+ "enumDescriptions": [
+ "Person is not applicable in the analyzed language or is not predicted.",
+ "First",
+ "Second",
+ "Third",
+ "Reflexive"
+ ],
+ "enum": [
+ "PERSON_UNKNOWN",
+ "FIRST",
+ "SECOND",
+ "THIRD",
+ "REFLEXIVE_PERSON"
+ ],
+ "description": "The grammatical person.",
+ "type": "string"
+ },
+ "proper": {
"description": "The grammatical properness.",
"type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
"Not proper"
+ ],
+ "enum": [
+ "PROPER_UNKNOWN",
+ "PROPER",
+ "NOT_PROPER"
]
},
"case": {
+ "description": "The grammatical case.",
+ "type": "string",
"enumDescriptions": [
"Case is not applicable in the analyzed language or is not predicted.",
"Accusative",
@@ -224,11 +279,11 @@
"REFLEXIVE_CASE",
"RELATIVE_CASE",
"VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
+ ]
},
"tense": {
+ "description": "The grammatical tense.",
+ "type": "string",
"enumDescriptions": [
"Tense is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -246,13 +301,9 @@
"PRESENT",
"IMPERFECT",
"PLUPERFECT"
- ],
- "description": "The grammatical tense.",
- "type": "string"
+ ]
},
"reciprocity": {
- "description": "The grammatical reciprocity.",
- "type": "string",
"enumDescriptions": [
"Reciprocity is not applicable in the analyzed language or is not\npredicted.",
"Reciprocal",
@@ -262,192 +313,22 @@
"RECIPROCITY_UNKNOWN",
"RECIPROCAL",
"NON_RECIPROCAL"
- ]
- },
- "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": {
- "enum": [
- "NUMBER_UNKNOWN",
- "SINGULAR",
- "PLURAL",
- "DUAL"
- ],
- "description": "The grammatical number.",
- "type": "string",
- "enumDescriptions": [
- "Number is not applicable in the analyzed language or is not predicted.",
- "Singular",
- "Plural",
- "Dual"
- ]
- },
- "voice": {
- "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": {
- "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.",
+ "description": "The grammatical reciprocity.",
"type": "string"
- },
- "mood": {
- "type": "string",
- "enumDescriptions": [
- "Mood is not applicable in the analyzed language or is not predicted.",
- "Conditional",
- "Imperative",
- "Indicative",
- "Interrogative",
- "Jussive",
- "Subjunctive"
- ],
- "enum": [
- "MOOD_UNKNOWN",
- "CONDITIONAL_MOOD",
- "IMPERATIVE",
- "INDICATIVE",
- "INTERROGATIVE",
- "JUSSIVE",
- "SUBJUNCTIVE"
- ],
- "description": "The grammatical mood."
- },
- "tag": {
- "description": "The part of speech tag.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Adjective",
- "Adposition (preposition and postposition)",
- "Adverb",
- "Conjunction",
- "Determiner",
- "Noun (common and proper)",
- "Cardinal number",
- "Pronoun",
- "Particle or other function word",
- "Punctuation",
- "Verb (all tenses and modes)",
- "Other: foreign words, typos, abbreviations",
- "Affix"
- ],
- "enum": [
- "UNKNOWN",
- "ADJ",
- "ADP",
- "ADV",
- "CONJ",
- "DET",
- "NOUN",
- "NUM",
- "PRON",
- "PRT",
- "PUNCT",
- "VERB",
- "X",
- "AFFIX"
- ]
- },
- "gender": {
- "enum": [
- "GENDER_UNKNOWN",
- "FEMININE",
- "MASCULINE",
- "NEUTER"
- ],
- "description": "The grammatical gender.",
- "type": "string",
- "enumDescriptions": [
- "Gender is not applicable in the analyzed language or is not predicted.",
- "Feminine",
- "Masculine",
- "Neuter"
- ]
- },
- "person": {
- "type": "string",
- "enumDescriptions": [
- "Person is not applicable in the analyzed language or is not predicted.",
- "First",
- "Second",
- "Third",
- "Reflexive"
- ],
- "enum": [
- "PERSON_UNKNOWN",
- "FIRST",
- "SECOND",
- "THIRD",
- "REFLEXIVE_PERSON"
- ],
- "description": "The grammatical person."
}
},
"id": "PartOfSpeech"
},
"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": [
@@ -455,19 +336,25 @@
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
"Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
]
- },
- "document": {
- "$ref": "Document",
- "description": "Input document."
}
},
- "id": "AnalyzeSyntaxRequest",
- "description": "The syntax analysis request message.",
- "type": "object"
+ "id": "AnalyzeSyntaxRequest"
},
"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"
@@ -478,94 +365,32 @@
"items": {
"$ref": "Sentence"
}
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment of the input document."
}
},
- "id": "AnalyzeSentimentResponse",
- "description": "The sentiment analysis response message.",
- "type": "object"
+ "id": "AnalyzeSentimentResponse"
},
"AnalyzeEntitiesResponse": {
+ "description": "The entity analysis response message.",
"type": "object",
"properties": {
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee `Document.language` field for more details.",
+ "type": "string"
+ },
"entities": {
"description": "The recognized entities in the input document.",
"type": "array",
"items": {
"$ref": "Entity"
}
- },
- "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."
- },
- "Entity": {
- "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
- "type": "object",
- "properties": {
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "type": "array",
- "items": {
- "$ref": "EntityMention"
- }
- },
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- },
- "type": {
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ],
- "description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ]
- },
- "metadata": {
- "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"
- }
- },
- "salience": {
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "format": "float",
- "type": "number"
- }
- },
- "id": "Entity"
+ "id": "AnalyzeEntitiesResponse"
},
"AnalyzeSyntaxResponse": {
+ "description": "The syntax analysis response message.",
+ "type": "object",
"properties": {
- "language": {
- "type": "string",
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee `Document.language` field for more details."
- },
"sentences": {
"description": "Sentences in the input document.",
"type": "array",
@@ -579,25 +404,74 @@
"items": {
"$ref": "Token"
}
+ },
+ "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",
- "description": "The syntax analysis response message.",
- "type": "object"
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "salience": {
+ "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
+ "format": "float",
+ "type": "number"
+ },
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityMention"
+ }
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ }
+ },
+ "id": "Entity"
},
"AnnotateTextRequest": {
"description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
"type": "object",
"properties": {
- "document": {
- "$ref": "Document",
- "description": "Input document."
- },
- "features": {
- "$ref": "Features",
- "description": "The enabled features."
- },
"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`.",
@@ -610,18 +484,57 @@
"UTF8",
"UTF16",
"UTF32"
- ],
- "description": "The encoding type used by the API to calculate offsets."
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document."
+ },
+ "features": {
+ "$ref": "Features",
+ "description": "The enabled features."
}
},
"id": "AnnotateTextRequest"
},
- "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.",
+ "type": "string"
+ },
+ "document": {
+ "description": "Input document. Currently, `analyzeSentiment` only supports English text\n(Document.language=\"EN\").",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
+ },
+ "AnnotateTextResponse": {
+ "description": "The text annotations response message.",
+ "type": "object",
+ "properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
+ },
"language": {
- "type": "string",
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee `Document.language` field for more details."
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee `Document.language` field for more details.",
+ "type": "string"
},
"sentences": {
"description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
@@ -643,127 +556,20 @@
"items": {
"$ref": "Entity"
}
- },
- "documentSentiment": {
- "$ref": "Sentiment",
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
}
},
- "id": "AnnotateTextResponse",
- "description": "The text annotations response message."
- },
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "encodingType": {
- "description": "The encoding type used by the API to calculate sentence offsets.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ]
- },
- "document": {
- "$ref": "Document",
- "description": "Input document. Currently, `analyzeSentiment` only supports English text\n(Document.language=\"EN\")."
- }
- },
- "id": "AnalyzeSentimentRequest"
+ "id": "AnnotateTextResponse"
},
"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": {
+ "headTokenIndex": {
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "format": "int32",
+ "type": "integer"
+ },
"label": {
- "enum": [
- "UNKNOWN",
- "ABBREV",
- "ACOMP",
- "ADVCL",
- "ADVMOD",
- "AMOD",
- "APPOS",
- "ATTR",
- "AUX",
- "AUXPASS",
- "CC",
- "CCOMP",
- "CONJ",
- "CSUBJ",
- "CSUBJPASS",
- "DEP",
- "DET",
- "DISCOURSE",
- "DOBJ",
- "EXPL",
- "GOESWITH",
- "IOBJ",
- "MARK",
- "MWE",
- "MWV",
- "NEG",
- "NN",
- "NPADVMOD",
- "NSUBJ",
- "NSUBJPASS",
- "NUM",
- "NUMBER",
- "P",
- "PARATAXIS",
- "PARTMOD",
- "PCOMP",
- "POBJ",
- "POSS",
- "POSTNEG",
- "PRECOMP",
- "PRECONJ",
- "PREDET",
- "PREF",
- "PREP",
- "PRONL",
- "PRT",
- "PS",
- "QUANTMOD",
- "RCMOD",
- "RCMODREL",
- "RDROP",
- "REF",
- "REMNANT",
- "REPARANDUM",
- "ROOT",
- "SNUM",
- "SUFF",
- "TMOD",
- "TOPIC",
- "VMOD",
- "VOCATIVE",
- "XCOMP",
- "SUFFIX",
- "TITLE",
- "ADVPHMOD",
- "AUXCAUS",
- "AUXVV",
- "DTMOD",
- "FOREIGN",
- "KW",
- "LIST",
- "NOMC",
- "NOMCSUBJ",
- "NOMCSUBJPASS",
- "NUMC",
- "COP",
- "DISLOCATED"
- ],
"description": "The parse label for the token.",
"type": "string",
"enumDescriptions": [
@@ -844,14 +650,89 @@
"Compound of numeric modifier",
"Copula",
"Dislocated relation (for fronted/topicalized elements)"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "ABBREV",
+ "ACOMP",
+ "ADVCL",
+ "ADVMOD",
+ "AMOD",
+ "APPOS",
+ "ATTR",
+ "AUX",
+ "AUXPASS",
+ "CC",
+ "CCOMP",
+ "CONJ",
+ "CSUBJ",
+ "CSUBJPASS",
+ "DEP",
+ "DET",
+ "DISCOURSE",
+ "DOBJ",
+ "EXPL",
+ "GOESWITH",
+ "IOBJ",
+ "MARK",
+ "MWE",
+ "MWV",
+ "NEG",
+ "NN",
+ "NPADVMOD",
+ "NSUBJ",
+ "NSUBJPASS",
+ "NUM",
+ "NUMBER",
+ "P",
+ "PARATAXIS",
+ "PARTMOD",
+ "PCOMP",
+ "POBJ",
+ "POSS",
+ "POSTNEG",
+ "PRECOMP",
+ "PRECONJ",
+ "PREDET",
+ "PREF",
+ "PREP",
+ "PRONL",
+ "PRT",
+ "PS",
+ "QUANTMOD",
+ "RCMOD",
+ "RCMODREL",
+ "RDROP",
+ "REF",
+ "REMNANT",
+ "REPARANDUM",
+ "ROOT",
+ "SNUM",
+ "SUFF",
+ "TMOD",
+ "TOPIC",
+ "VMOD",
+ "VOCATIVE",
+ "XCOMP",
+ "SUFFIX",
+ "TITLE",
+ "ADVPHMOD",
+ "AUXCAUS",
+ "AUXVV",
+ "DTMOD",
+ "FOREIGN",
+ "KW",
+ "LIST",
+ "NOMC",
+ "NOMCSUBJ",
+ "NOMCSUBJPASS",
+ "NUMC",
+ "COP",
+ "DISLOCATED"
]
- },
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
}
- }
+ },
+ "id": "DependencyEdge"
},
"TextSpan": {
"description": "Represents an output piece of text.",
@@ -874,12 +755,12 @@
"type": "object",
"properties": {
"partOfSpeech": {
- "description": "Parts of speech tag for this token.",
- "$ref": "PartOfSpeech"
+ "$ref": "PartOfSpeech",
+ "description": "Parts of speech tag for this token."
},
"text": {
- "$ref": "TextSpan",
- "description": "The token text."
+ "description": "The token text.",
+ "$ref": "TextSpan"
},
"dependencyEdge": {
"$ref": "DependencyEdge",
@@ -891,13 +772,132 @@
}
},
"id": "Token"
+ },
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "Status"
+ },
+ "Features": {
+ "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
+ "type": "object",
+ "properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
+ "extractSyntax": {
+ "description": "Extract syntax information.",
+ "type": "boolean"
+ },
+ "extractDocumentSentiment": {
+ "description": "Extract document-level sentiment.",
+ "type": "boolean"
+ }
+ },
+ "id": "Features"
+ },
+ "EntityMention": {
+ "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.",
+ "type": "object",
+ "properties": {
+ "text": {
+ "$ref": "TextSpan",
+ "description": "The mention text."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Proper name",
+ "Common noun (or noun compound)"
+ ],
+ "enum": [
+ "TYPE_UNKNOWN",
+ "PROPER",
+ "COMMON"
+ ],
+ "description": "The type of the entity mention.",
+ "type": "string"
+ }
+ },
+ "id": "EntityMention"
+ },
+ "Document": {
+ "description": "################################################################ #\n\nRepresents the input to API methods.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
+ "type": "string",
+ "enumDescriptions": [
+ "The content type is not specified.",
+ "Plain text",
+ "HTML"
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PLAIN_TEXT",
+ "HTML"
+ ]
+ },
+ "content": {
+ "description": "The content of the input in string format.",
+ "type": "string"
+ },
+ "gcsContentUri": {
+ "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.",
+ "type": "string"
+ },
+ "language": {
+ "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n**Current Language Restrictions:**\n\n * Only English, Spanish, and Japanese textual content are supported.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.",
+ "type": "string"
+ }
+ },
+ "id": "Document"
+ },
+ "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"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
@@ -917,82 +917,92 @@
"resources": {
"documents": {
"methods": {
- "analyzeSentiment": {
- "id": "language.documents.analyzeSentiment",
- "path": "v1/documents:analyzeSentiment",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "description": "Analyzes the sentiment of the provided text.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeSentiment"
- },
- "annotateText": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:annotateText",
- "id": "language.documents.annotateText",
- "path": "v1/documents:annotateText",
- "request": {
- "$ref": "AnnotateTextRequest"
- },
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call."
- },
- "analyzeEntities": {
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- },
- "description": "Finds named entities (currently finds proper names) in the text,\nentity types, salience, mentions for each entity, and other properties.",
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/documents:analyzeEntities",
- "path": "v1/documents:analyzeEntities",
- "id": "language.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"
},
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "AnalyzeSyntaxResponse"
},
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1/documents:analyzeSyntax"
+ },
+ "analyzeSentiment": {
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {},
- "flatPath": "v1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1/documents:analyzeSyntax"
+ "flatPath": "v1/documents:analyzeSentiment",
+ "path": "v1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ }
+ },
+ "annotateText": {
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {},
+ "flatPath": "v1/documents:annotateText",
+ "id": "language.documents.annotateText",
+ "path": "v1/documents:annotateText"
+ },
+ "analyzeEntities": {
+ "flatPath": "v1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "path": "v1/documents:analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently finds proper names) in the text,\nentity types, salience, mentions for each entity, and other properties.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
},
"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\").",
@@ -1004,22 +1014,23 @@
"type": "boolean",
"default": "true"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "callback": {
+ "fields": {
"location": "query",
- "description": "JSONP",
+ "description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -1029,15 +1040,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
@@ -1046,12 +1051,17 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -1064,20 +1074,10 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
- },
- "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"
+ "default": "true"
}
},
"version": "v1",
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json
index 060d48f..7ce54f3 100644
--- a/language/v1beta1/language-api.json
+++ b/language/v1beta1/language-api.json
@@ -1,184 +1,43 @@
{
- "title": "Google Cloud Natural Language API",
- "ownerName": "Google",
- "resources": {
- "documents": {
- "methods": {
- "annotateText": {
- "response": {
- "$ref": "AnnotateTextResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:annotateText",
- "path": "v1beta1/documents:annotateText",
- "id": "language.documents.annotateText",
- "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
- "request": {
- "$ref": "AnnotateTextRequest"
- }
- },
- "analyzeEntities": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeEntitiesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:analyzeEntities",
- "id": "language.documents.analyzeEntities",
- "path": "v1beta1/documents:analyzeEntities",
- "description": "Finds named entities (currently finds proper names) in the text,\nentity types, salience, mentions for each entity, and other properties.",
- "request": {
- "$ref": "AnalyzeEntitiesRequest"
- }
- },
- "analyzeSyntax": {
- "flatPath": "v1beta1/documents:analyzeSyntax",
- "id": "language.documents.analyzeSyntax",
- "path": "v1beta1/documents:analyzeSyntax",
- "request": {
- "$ref": "AnalyzeSyntaxRequest"
- },
- "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSyntaxResponse"
- },
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ]
- },
- "analyzeSentiment": {
- "description": "Analyzes the sentiment of the provided text.",
- "request": {
- "$ref": "AnalyzeSentimentRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "AnalyzeSentimentResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {},
- "flatPath": "v1beta1/documents:analyzeSentiment",
- "id": "language.documents.analyzeSentiment",
- "path": "v1beta1/documents:analyzeSentiment"
- }
- }
- }
- },
- "parameters": {
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "description": "API key. Your API 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": "v1beta1",
"baseUrl": "https://language.googleapis.com/",
"servicePath": "",
"description": "Google Cloud Natural Language API provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, and text annotations.",
"kind": "discovery#restDescription",
"basePath": "",
- "revision": "20170301",
"id": "language:v1beta1",
"documentationLink": "https://cloud.google.com/natural-language/",
+ "revision": "20170301",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "AnalyzeEntitiesRequest": {
+ "description": "The entity analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "description": "The encoding type used by the API to calculate offsets.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ]
+ },
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ }
+ },
+ "id": "AnalyzeEntitiesRequest"
+ },
"Sentiment": {
"description": "Represents the feeling associated with the entire text or entities in\nthe text.",
"type": "object",
@@ -201,51 +60,10 @@
},
"id": "Sentiment"
},
- "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"
- },
"PartOfSpeech": {
"description": "Represents part of speech information for a token.",
"type": "object",
"properties": {
- "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",
@@ -279,6 +97,8 @@
]
},
"number": {
+ "description": "The grammatical number.",
+ "type": "string",
"enumDescriptions": [
"Number is not applicable in the analyzed language or is not predicted.",
"Singular",
@@ -290,13 +110,9 @@
"SINGULAR",
"PLURAL",
"DUAL"
- ],
- "description": "The grammatical number.",
- "type": "string"
+ ]
},
"voice": {
- "description": "The grammatical voice.",
- "type": "string",
"enumDescriptions": [
"Voice is not applicable in the analyzed language or is not predicted.",
"Active",
@@ -308,7 +124,9 @@
"ACTIVE",
"CAUSATIVE",
"PASSIVE"
- ]
+ ],
+ "description": "The grammatical voice.",
+ "type": "string"
},
"aspect": {
"enumDescriptions": [
@@ -349,6 +167,8 @@
]
},
"tag": {
+ "description": "The part of speech tag.",
+ "type": "string",
"enumDescriptions": [
"Unknown",
"Adjective",
@@ -380,13 +200,9 @@
"VERB",
"X",
"AFFIX"
- ],
- "description": "The part of speech tag.",
- "type": "string"
+ ]
},
"gender": {
- "description": "The grammatical gender.",
- "type": "string",
"enumDescriptions": [
"Gender is not applicable in the analyzed language or is not predicted.",
"Feminine",
@@ -398,7 +214,9 @@
"FEMININE",
"MASCULINE",
"NEUTER"
- ]
+ ],
+ "description": "The grammatical gender.",
+ "type": "string"
},
"person": {
"enumDescriptions": [
@@ -419,6 +237,8 @@
"type": "string"
},
"proper": {
+ "description": "The grammatical properness.",
+ "type": "string",
"enumDescriptions": [
"Proper is not applicable in the analyzed language or is not predicted.",
"Proper",
@@ -428,11 +248,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",
@@ -466,13 +286,9 @@
"REFLEXIVE_CASE",
"RELATIVE_CASE",
"VOCATIVE"
- ],
- "description": "The grammatical case.",
- "type": "string"
+ ]
},
"tense": {
- "description": "The grammatical tense.",
- "type": "string",
"enumDescriptions": [
"Tense is not applicable in the analyzed language or is not predicted.",
"Conditional",
@@ -490,6 +306,22 @@
"PRESENT",
"IMPERFECT",
"PLUPERFECT"
+ ],
+ "description": "The grammatical tense.",
+ "type": "string"
+ },
+ "reciprocity": {
+ "description": "The grammatical reciprocity.",
+ "type": "string",
+ "enumDescriptions": [
+ "Reciprocity is not applicable in the analyzed language or is not\npredicted.",
+ "Reciprocal",
+ "Non-reciprocal"
+ ],
+ "enum": [
+ "RECIPROCITY_UNKNOWN",
+ "RECIPROCAL",
+ "NON_RECIPROCAL"
]
}
},
@@ -499,6 +331,10 @@
"description": "The syntax analysis request message.",
"type": "object",
"properties": {
+ "document": {
+ "description": "Input document.",
+ "$ref": "Document"
+ },
"encodingType": {
"enumDescriptions": [
"If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
@@ -514,10 +350,6 @@
],
"description": "The encoding type used by the API to calculate offsets.",
"type": "string"
- },
- "document": {
- "description": "Input document.",
- "$ref": "Document"
}
},
"id": "AnalyzeSyntaxRequest"
@@ -526,20 +358,20 @@
"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.",
- "type": "string"
- },
"sentences": {
"description": "The sentiment for all the sentences in the document.",
"type": "array",
"items": {
"$ref": "Sentence"
}
+ },
+ "documentSentiment": {
+ "description": "The overall sentiment of the input document.",
+ "$ref": "Sentiment"
+ },
+ "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.",
+ "type": "string"
}
},
"id": "AnalyzeSentimentResponse"
@@ -562,6 +394,60 @@
},
"id": "AnalyzeEntitiesResponse"
},
+ "Entity": {
+ "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.",
+ "type": "object",
+ "properties": {
+ "mentions": {
+ "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityMention"
+ }
+ },
+ "name": {
+ "description": "The representative name for the entity.",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown",
+ "Person",
+ "Location",
+ "Organization",
+ "Event",
+ "Work of art",
+ "Consumer goods",
+ "Other types"
+ ],
+ "enum": [
+ "UNKNOWN",
+ "PERSON",
+ "LOCATION",
+ "ORGANIZATION",
+ "EVENT",
+ "WORK_OF_ART",
+ "CONSUMER_GOOD",
+ "OTHER"
+ ],
+ "description": "The entity type.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
+ "type": "object"
+ },
+ "salience": {
+ "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
+ "format": "float",
+ "type": "number"
+ }
+ },
+ "id": "Entity"
+ },
"AnalyzeSyntaxResponse": {
"description": "The syntax analysis response message.",
"type": "object",
@@ -587,64 +473,26 @@
},
"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": {
- "type": {
- "description": "The entity type.",
- "type": "string",
- "enumDescriptions": [
- "Unknown",
- "Person",
- "Location",
- "Organization",
- "Event",
- "Work of art",
- "Consumer goods",
- "Other types"
- ],
- "enum": [
- "UNKNOWN",
- "PERSON",
- "LOCATION",
- "ORGANIZATION",
- "EVENT",
- "WORK_OF_ART",
- "CONSUMER_GOOD",
- "OTHER"
- ]
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.",
- "type": "object"
- },
- "salience": {
- "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.",
- "format": "float",
- "type": "number"
- },
- "mentions": {
- "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.",
- "type": "array",
- "items": {
- "$ref": "EntityMention"
- }
- },
- "name": {
- "description": "The representative name for the entity.",
- "type": "string"
- }
- },
- "id": "Entity"
- },
"AnnotateTextRequest": {
"description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.",
"type": "object",
"properties": {
+ "encodingType": {
+ "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"
@@ -652,57 +500,22 @@
"features": {
"description": "The enabled features.",
"$ref": "Features"
- },
- "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": "AnnotateTextRequest"
},
- "AnalyzeSentimentRequest": {
- "description": "The sentiment analysis request message.",
- "type": "object",
- "properties": {
- "document": {
- "description": "Input document. Currently, `analyzeSentiment` only supports English text\n(Document.language=\"EN\").",
- "$ref": "Document"
- },
- "encodingType": {
- "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
- "type": "string",
- "enumDescriptions": [
- "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
- "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
- ],
- "enum": [
- "NONE",
- "UTF8",
- "UTF16",
- "UTF32"
- ]
- }
- },
- "id": "AnalyzeSentimentRequest"
- },
"AnnotateTextResponse": {
"description": "The text annotations response message.",
"type": "object",
"properties": {
+ "documentSentiment": {
+ "$ref": "Sentiment",
+ "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment."
+ },
+ "language": {
+ "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
+ "type": "string"
+ },
"sentences": {
"description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.",
"type": "array",
@@ -723,22 +536,46 @@
"items": {
"$ref": "Entity"
}
- },
- "documentSentiment": {
- "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.",
- "$ref": "Sentiment"
- },
- "language": {
- "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.",
- "type": "string"
}
},
"id": "AnnotateTextResponse"
},
+ "AnalyzeSentimentRequest": {
+ "description": "The sentiment analysis request message.",
+ "type": "object",
+ "properties": {
+ "encodingType": {
+ "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.",
+ "type": "string",
+ "enumDescriptions": [
+ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.",
+ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively."
+ ],
+ "enum": [
+ "NONE",
+ "UTF8",
+ "UTF16",
+ "UTF32"
+ ]
+ },
+ "document": {
+ "$ref": "Document",
+ "description": "Input document. Currently, `analyzeSentiment` only supports English text\n(Document.language=\"EN\")."
+ }
+ },
+ "id": "AnalyzeSentimentRequest"
+ },
"DependencyEdge": {
"description": "Represents dependency parse tree information for a token.",
"type": "object",
"properties": {
+ "headTokenIndex": {
+ "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
+ "format": "int32",
+ "type": "integer"
+ },
"label": {
"enumDescriptions": [
"Unknown",
@@ -900,11 +737,6 @@
],
"description": "The parse label for the token.",
"type": "string"
- },
- "headTokenIndex": {
- "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.",
- "format": "int32",
- "type": "integer"
}
},
"id": "DependencyEdge"
@@ -913,21 +745,21 @@
"description": "Represents the smallest syntactic building block of the text.",
"type": "object",
"properties": {
+ "partOfSpeech": {
+ "description": "Parts of speech tag for this token.",
+ "$ref": "PartOfSpeech"
+ },
"text": {
- "$ref": "TextSpan",
- "description": "The token text."
+ "description": "The token text.",
+ "$ref": "TextSpan"
},
"dependencyEdge": {
- "description": "Dependency tree parse for this token.",
- "$ref": "DependencyEdge"
+ "$ref": "DependencyEdge",
+ "description": "Dependency tree parse for this token."
},
"lemma": {
"description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.",
"type": "string"
- },
- "partOfSpeech": {
- "$ref": "PartOfSpeech",
- "description": "Parts of speech tag for this token."
}
},
"id": "Token"
@@ -952,6 +784,17 @@
"description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -960,17 +803,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 will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
}
},
"id": "Status"
@@ -980,10 +812,12 @@
"type": "object",
"properties": {
"text": {
- "description": "The mention text.",
- "$ref": "TextSpan"
+ "$ref": "TextSpan",
+ "description": "The mention text."
},
"type": {
+ "description": "The type of the entity mention.",
+ "type": "string",
"enumDescriptions": [
"Unknown",
"Proper name",
@@ -993,9 +827,7 @@
"TYPE_UNKNOWN",
"PROPER",
"COMMON"
- ],
- "description": "The type of the entity mention.",
- "type": "string"
+ ]
}
},
"id": "EntityMention"
@@ -1004,6 +836,10 @@
"description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.",
"type": "object",
"properties": {
+ "extractEntities": {
+ "description": "Extract entities.",
+ "type": "boolean"
+ },
"extractSyntax": {
"description": "Extract syntax information.",
"type": "boolean"
@@ -1011,14 +847,25 @@
"extractDocumentSentiment": {
"description": "Extract document-level sentiment.",
"type": "boolean"
- },
- "extractEntities": {
- "description": "Extract entities.",
- "type": "boolean"
}
},
"id": "Features"
},
+ "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"
+ },
"Document": {
"description": "################################################################ #\n\nRepresents the input to API methods.",
"type": "object",
@@ -1028,6 +875,8 @@
"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",
@@ -1037,9 +886,7 @@
"TYPE_UNSPECIFIED",
"PLAIN_TEXT",
"HTML"
- ],
- "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.",
- "type": "string"
+ ]
},
"content": {
"description": "The content of the input in string format.",
@@ -1051,28 +898,13 @@
}
},
"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"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"canonicalName": "Cloud Natural Language",
"auth": {
"oauth2": {
@@ -1086,5 +918,173 @@
"rootUrl": "https://language.googleapis.com/",
"ownerDomain": "google.com",
"name": "language",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Google Cloud Natural Language API",
+ "ownerName": "Google",
+ "resources": {
+ "documents": {
+ "methods": {
+ "analyzeSyntax": {
+ "request": {
+ "$ref": "AnalyzeSyntaxRequest"
+ },
+ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "AnalyzeSyntaxResponse"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:analyzeSyntax",
+ "id": "language.documents.analyzeSyntax",
+ "path": "v1beta1/documents:analyzeSyntax"
+ },
+ "analyzeSentiment": {
+ "flatPath": "v1beta1/documents:analyzeSentiment",
+ "path": "v1beta1/documents:analyzeSentiment",
+ "id": "language.documents.analyzeSentiment",
+ "description": "Analyzes the sentiment of the provided text.",
+ "request": {
+ "$ref": "AnalyzeSentimentRequest"
+ },
+ "response": {
+ "$ref": "AnalyzeSentimentResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {}
+ },
+ "annotateText": {
+ "request": {
+ "$ref": "AnnotateTextRequest"
+ },
+ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.",
+ "response": {
+ "$ref": "AnnotateTextResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:annotateText",
+ "path": "v1beta1/documents:annotateText",
+ "id": "language.documents.annotateText"
+ },
+ "analyzeEntities": {
+ "response": {
+ "$ref": "AnalyzeEntitiesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/documents:analyzeEntities",
+ "path": "v1beta1/documents:analyzeEntities",
+ "id": "language.documents.analyzeEntities",
+ "request": {
+ "$ref": "AnalyzeEntitiesRequest"
+ },
+ "description": "Finds named entities (currently finds proper names) in the text,\nentity types, salience, mentions for each entity, and other properties."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "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": {
+ "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"
+ }
+ }
}
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json
index a0d9944..f64ee20 100644
--- a/logging/v2/logging-api.json
+++ b/logging/v2/logging-api.json
@@ -1,1383 +1,57 @@
{
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "folders": {
- "resources": {
- "logs": {
- "methods": {
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32"
- },
- "parent": {
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/folders/{foldersId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.folders.logs.list"
- },
- "delete": {
- "path": "v2/{+logName}",
- "id": "logging.folders.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/logs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/folders/{foldersId}/logs/{logsId}"
- }
- }
- },
- "sinks": {
- "methods": {
- "update": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "sinkName": {
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean"
- }
- },
- "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",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field."
- },
- "create": {
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "request": {
- "$ref": "LogSink"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "uniqueWriterIdentity": {
- "type": "boolean",
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
- },
- "parent": {
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.folders.sinks.create"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.folders.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "list": {
- "flatPath": "v2/folders/{foldersId}/sinks",
- "id": "logging.folders.sinks.list",
- "path": "v2/{+parent}/sinks",
- "description": "Lists sinks.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^folders/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "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": {
- "pattern": "^folders/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
- "id": "logging.folders.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink."
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list",
- "path": "v2/monitoredResourceDescriptors",
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "logName": {
- "pattern": "^organizations/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
- "path": "v2/{+logName}",
- "id": "logging.organizations.logs.delete"
- },
- "list": {
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListLogsResponse"
- },
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.organizations.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- }
- }
- },
- "sinks": {
- "methods": {
- "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": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "id": "logging.organizations.sinks.list",
- "path": "v2/{+parent}/sinks"
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/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/organizations/{organizationsId}/sinks/{sinksId}",
- "id": "logging.organizations.sinks.get",
- "path": "v2/{+sinkName}",
- "description": "Gets a sink."
- },
- "update": {
- "id": "logging.organizations.sinks.update",
- "path": "v2/{+sinkName}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}"
- },
- "create": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.organizations.sinks.create",
- "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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "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\".",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.organizations.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- }
- }
- }
- }
- },
- "entries": {
- "methods": {
- "list": {
- "path": "v2/entries:list",
- "id": "logging.entries.list",
- "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
- "request": {
- "$ref": "ListLogEntriesRequest"
- },
- "response": {
- "$ref": "ListLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {},
- "flatPath": "v2/entries:list"
- },
- "write": {
- "response": {
- "$ref": "WriteLogEntriesResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "parameters": {},
- "flatPath": "v2/entries:write",
- "path": "v2/entries:write",
- "id": "logging.entries.write",
- "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- }
- }
- }
- },
- "projects": {
- "resources": {
- "metrics": {
- "methods": {
- "update": {
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2/{+metricName}",
- "id": "logging.projects.metrics.update",
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates or updates a logs-based metric.",
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "metricName"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "metricName": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ]
- },
- "create": {
- "request": {
- "$ref": "LogMetric"
- },
- "description": "Creates a logs-based metric.",
- "response": {
- "$ref": "LogMetric"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2/projects/{projectsId}/metrics",
- "path": "v2/{+parent}/metrics",
- "id": "logging.projects.metrics.create"
- },
- "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": {
- "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.delete",
- "path": "v2/{+metricName}"
- },
- "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": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.list",
- "path": "v2/{+parent}/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": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2/{+metricName}"
- }
- }
- },
- "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": {
- "pattern": "^projects/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
- "id": "logging.projects.logs.delete",
- "path": "v2/{+logName}"
- },
- "list": {
- "path": "v2/{+parent}/logs",
- "id": "logging.projects.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- }
- },
- "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"
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.delete"
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "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",
- "description": "Lists sinks."
- },
- "get": {
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.get",
- "description": "Gets a sink.",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "httpMethod": "GET"
- },
- "update": {
- "path": "v2/{+sinkName}",
- "id": "logging.projects.sinks.update",
- "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- },
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path",
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string"
- },
- "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 false.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}"
- },
- "create": {
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "parent": {
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "uniqueWriterIdentity": {
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v2/projects/{projectsId}/sinks",
- "path": "v2/{+parent}/sinks",
- "id": "logging.projects.sinks.create",
- "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or 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"
- }
- }
- }
- }
- }
- },
- "billingAccounts": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "parameters": {
- "logName": {
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "id": "logging.billingAccounts.logs.delete",
- "path": "v2/{+logName}",
- "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": {
- "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": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
- "path": "v2/{+parent}/logs",
- "id": "logging.billingAccounts.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET"
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "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\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "path": "v2/{+sinkName}",
- "id": "logging.billingAccounts.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "list": {
- "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": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
- "id": "logging.billingAccounts.sinks.list",
- "path": "v2/{+parent}/sinks",
- "description": "Lists sinks."
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "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."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean"
- }
- },
- "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
- "id": "logging.billingAccounts.sinks.update",
- "path": "v2/{+sinkName}",
- "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
- "request": {
- "$ref": "LogSink"
- }
- },
- "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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
- },
- "uniqueWriterIdentity": {
- "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/billingAccounts/{billingAccountsId}/sinks"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "alt": {
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ]
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v2",
- "baseUrl": "https://logging.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "servicePath": "",
- "basePath": "",
- "id": "logging:v2",
- "documentationLink": "https://cloud.google.com/logging/docs/",
- "revision": "20170228",
- "discoveryVersion": "v1",
- "version_module": "True",
"schemas": {
- "LogLine": {
- "description": "Application log line emitted while processing a request.",
- "type": "object",
- "properties": {
- "time": {
- "type": "string",
- "description": "Approximate time when this log entry was made.",
- "format": "google-datetime"
- },
- "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"
- },
- "logMessage": {
- "description": "App-provided log message.",
- "type": "string"
- },
- "sourceLocation": {
- "$ref": "SourceLocation",
- "description": "Where in the source code this log message was written."
- }
- },
- "id": "LogLine"
- },
- "ListLogMetricsResponse": {
- "description": "Result returned from ListLogMetrics.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "type": "string",
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
- },
- "metrics": {
- "type": "array",
- "items": {
- "$ref": "LogMetric"
- },
- "description": "A list of logs-based metrics."
- }
- },
- "id": "ListLogMetricsResponse"
- },
- "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"
- },
"LogEntry": {
"description": "An individual entry in a log.",
"type": "object",
"properties": {
+ "httpRequest": {
+ "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.",
+ "$ref": "HttpRequest"
+ },
+ "resource": {
+ "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.",
+ "$ref": "MonitoredResource"
+ },
+ "jsonPayload": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object."
+ },
+ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
+ "type": "object"
+ },
+ "operation": {
+ "description": "Optional. Information about an operation associated with the log entry, if applicable.",
+ "$ref": "LogEntryOperation"
+ },
+ "insertId": {
+ "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging will insert its own unique identifier. The insert_id is 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": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.",
+ "type": "object"
+ },
+ "trace": {
+ "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": {
- "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",
@@ -1390,80 +64,44 @@
"EMERGENCY"
],
"description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.",
- "type": "string"
+ "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": {
"$ref": "LogEntrySourceLocation",
"description": "Optional. Source code location information associated with the log entry, if any."
},
"timestamp": {
- "description": "Optional. The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received.",
+ "description": "Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.",
"format": "google-datetime",
"type": "string"
},
"logName": {
"description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
"type": "string"
- },
- "resource": {
- "$ref": "MonitoredResource",
- "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error."
- },
- "httpRequest": {
- "$ref": "HttpRequest",
- "description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
- },
- "jsonPayload": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
- "type": "object"
- },
- "operation": {
- "description": "Optional. Information about an operation associated with the log entry, if applicable.",
- "$ref": "LogEntryOperation"
- },
- "insertId": {
- "description": "Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same project with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry.",
- "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"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
- },
- "trace": {
- "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824",
- "type": "string"
}
},
"id": "LogEntry"
},
+ "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"
+ },
"SourceLocation": {
- "description": "Specifies a location in a source code file.",
"type": "object",
"properties": {
- "line": {
- "description": "Line within the source file.",
- "format": "int64",
- "type": "string"
- },
"file": {
"description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
"type": "string"
@@ -1471,20 +109,21 @@
"functionName": {
"description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
"type": "string"
+ },
+ "line": {
+ "description": "Line within the source file.",
+ "format": "int64",
+ "type": "string"
}
},
- "id": "SourceLocation"
+ "id": "SourceLocation",
+ "description": "Specifies a location in a source code file."
},
"ListLogEntriesRequest": {
- "description": "The parameters to ListLogEntries.",
"type": "object",
"properties": {
- "orderBy": {
- "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of LogEntry.insertId.",
- "type": "string"
- },
- "resourceNames": {
- "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
+ "projectIds": {
+ "description": "Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: \"my-project-1A\". If present, these project identifiers are converted to resource name format and added to the list of resources in resource_names.",
"type": "array",
"items": {
"type": "string"
@@ -1494,29 +133,87 @@
"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": {
+ "pageToken": {
+ "type": "string",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
+ "type": "string"
+ },
+ "resourceNames": {
+ "description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "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."
- },
- "pageToken": {
- "type": "string",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
+ }
}
},
- "id": "ListLogEntriesRequest"
+ "id": "ListLogEntriesRequest",
+ "description": "The parameters to ListLogEntries."
},
"RequestLog": {
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
+ "nickname": {
+ "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
+ "type": "string"
+ },
+ "pendingTime": {
+ "description": "Time this request spent in the pending request queue.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "resource": {
+ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
+ "type": "string"
+ },
+ "status": {
+ "description": "HTTP response status code. Example: 200, 404.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "taskName": {
+ "type": "string",
+ "description": "Task name of the request, in the case of an offline request."
+ },
+ "urlMapEntry": {
+ "description": "File or class that handled the request.",
+ "type": "string"
+ },
+ "instanceIndex": {
+ "type": "integer",
+ "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
+ "format": "int32"
+ },
+ "host": {
+ "type": "string",
+ "description": "Internet host and port number of the resource being requested."
+ },
+ "finished": {
+ "description": "Whether this request is finished or active.",
+ "type": "boolean"
+ },
+ "httpVersion": {
+ "description": "HTTP version of request. Example: \"HTTP/1.1\".",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when the request started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "latency": {
+ "type": "string",
+ "description": "Latency of the request.",
+ "format": "google-duration"
+ },
"ip": {
"description": "Origin IP address.",
"type": "string"
@@ -1534,26 +231,26 @@
"type": "string"
},
"cost": {
- "type": "number",
"description": "An indication of the relative cost of serving this request.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"instanceId": {
"description": "An identifier for the instance that handled the request.",
"type": "string"
},
"megaCycles": {
- "type": "string",
"description": "Number of CPU megacycles used to process request.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"first": {
"description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.",
"type": "boolean"
},
"versionId": {
- "type": "string",
- "description": "Version of the application that handled this request."
+ "description": "Version of the application that handled this request.",
+ "type": "string"
},
"moduleId": {
"description": "Module of the application that handled this request.",
@@ -1595,93 +292,41 @@
"$ref": "LogLine"
}
},
- "referrer": {
- "description": "Referrer URL of request.",
- "type": "string"
- },
"taskQueueName": {
"description": "Queue name of the request, in the case of an offline request.",
"type": "string"
},
+ "referrer": {
+ "type": "string",
+ "description": "Referrer URL of request."
+ },
"requestId": {
- "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
- "type": "string"
- },
- "nickname": {
- "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.",
- "type": "string"
- },
- "resource": {
- "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
- "type": "string"
- },
- "pendingTime": {
"type": "string",
- "description": "Time this request spent in the pending request queue.",
- "format": "google-duration"
- },
- "status": {
- "description": "HTTP response status code. Example: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "taskName": {
- "description": "Task name of the request, in the case of an offline request.",
- "type": "string"
- },
- "urlMapEntry": {
- "description": "File or class that handled the request.",
- "type": "string"
- },
- "instanceIndex": {
- "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
- "format": "int32",
- "type": "integer"
- },
- "host": {
- "description": "Internet host and port number of the resource being requested.",
- "type": "string"
- },
- "finished": {
- "description": "Whether this request is finished or active.",
- "type": "boolean"
- },
- "httpVersion": {
- "description": "HTTP version of request. Example: \"HTTP/1.1\".",
- "type": "string"
- },
- "startTime": {
- "description": "Time when the request started.",
- "format": "google-datetime",
- "type": "string"
- },
- "latency": {
- "type": "string",
- "description": "Latency of the request.",
- "format": "google-duration"
+ "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."
}
},
"id": "RequestLog"
},
"ListMonitoredResourceDescriptorsResponse": {
- "description": "Result returned from ListMonitoredResourceDescriptors.",
- "type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"resourceDescriptors": {
"description": "A list of resource descriptors.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
}
},
- "id": "ListMonitoredResourceDescriptorsResponse"
+ "id": "ListMonitoredResourceDescriptorsResponse",
+ "description": "Result returned from ListMonitoredResourceDescriptors.",
+ "type": "object"
},
"SourceReference": {
+ "type": "object",
"properties": {
"revisionId": {
"description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
@@ -1693,28 +338,27 @@
}
},
"id": "SourceReference",
- "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.",
- "type": "object"
+ "description": "A reference to a particular snapshot of the source tree used to build and deploy an application."
},
"WriteLogEntriesResponse": {
- "id": "WriteLogEntriesResponse",
"description": "Result returned from WriteLogEntries. empty",
"type": "object",
- "properties": {}
+ "properties": {},
+ "id": "WriteLogEntriesResponse"
},
"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.",
+ "type": "object",
"properties": {
"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"
},
"description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
+ "type": "string",
+ "description": "Optional. A description of this metric, which is used in documentation."
},
"version": {
- "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.",
- "type": "string",
"enumDescriptions": [
"Stackdriver Logging API v2.",
"Stackdriver Logging API v1."
@@ -1722,16 +366,16 @@
"enum": [
"V2",
"V1"
- ]
+ ],
+ "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.",
+ "type": "string"
},
"filter": {
"description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
"type": "string"
}
},
- "id": "LogMetric",
- "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.",
- "type": "object"
+ "id": "LogMetric"
},
"LogEntryOperation": {
"properties": {
@@ -1748,8 +392,8 @@
"type": "string"
},
"first": {
- "type": "boolean",
- "description": "Optional. Set this to True if this is the first log entry in the operation."
+ "description": "Optional. Set this to True if this is the first log entry in the operation.",
+ "type": "boolean"
}
},
"id": "LogEntryOperation",
@@ -1757,42 +401,26 @@
"type": "object"
},
"MonitoredResource": {
- "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
- "type": "object",
"properties": {
- "type": {
- "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is \"cloudsql_database\".",
- "type": "string"
- },
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels \"database_id\" and \"zone\".",
"type": "object"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is \"cloudsql_database\".",
+ "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"
},
"WriteLogEntriesRequest": {
- "description": "The parameters to WriteLogEntries.",
"type": "object",
"properties": {
- "logName": {
- "type": "string",
- "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
- },
- "entries": {
- "description": "Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are added to those log entries that do not provide their own values for the fields.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.",
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- }
- },
- "partialSuccess": {
- "type": "boolean",
- "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors."
- },
"labels": {
"additionalProperties": {
"type": "string"
@@ -1803,17 +431,33 @@
"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"
+ },
+ "logName": {
+ "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "type": "string"
+ },
+ "entries": {
+ "description": "Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are inserted into those log entries in this list that do not provide their own values.Stackdriver Logging also creates and inserts values for timestamp and insert_id if the entries do not provide them. The created insert_id for the N'th entry in this list will be greater than earlier entries and less than later entries. Otherwise, the order of log entries in this list does not matter.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.",
+ "type": "array",
+ "items": {
+ "$ref": "LogEntry"
+ }
+ },
+ "partialSuccess": {
+ "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.",
+ "type": "boolean"
}
},
- "id": "WriteLogEntriesRequest"
+ "id": "WriteLogEntriesRequest",
+ "description": "The parameters to WriteLogEntries."
},
"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": {
"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"
+ "type": "string",
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks."
},
"filter": {
"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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
@@ -1834,7 +478,6 @@
"type": "string"
},
"outputVersionFormat": {
- "type": "string",
"enumDescriptions": [
"An unspecified format version that will default to V2.",
"LogEntry version 2 format.",
@@ -1845,32 +488,101 @@
"V2",
"V1"
],
- "description": "Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API."
+ "description": "Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.",
+ "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"
+ "type": "string",
+ "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods."
}
},
"id": "LogSink"
},
"ListLogsResponse": {
+ "id": "ListLogsResponse",
+ "description": "Result returned from ListLogs.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"logNames": {
"description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
}
- },
- "id": "ListLogsResponse",
- "description": "Result returned from ListLogs."
+ }
+ },
+ "HttpRequest": {
+ "id": "HttpRequest",
+ "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "The response code indicating the status of response. Examples: 200, 404.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "referer": {
+ "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
+ "type": "string"
+ },
+ "userAgent": {
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
+ "type": "string"
+ },
+ "latency": {
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "cacheFillBytes": {
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestMethod": {
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
+ "type": "string"
+ },
+ "responseSize": {
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestSize": {
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestUrl": {
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
+ "type": "string"
+ },
+ "remoteIp": {
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
+ "type": "string"
+ },
+ "serverIp": {
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
+ "type": "string"
+ },
+ "cacheLookup": {
+ "description": "Whether or not a cache lookup was attempted.",
+ "type": "boolean"
+ },
+ "cacheHit": {
+ "description": "Whether or not an entity was served from cache (with or without validation).",
+ "type": "boolean"
+ },
+ "cacheValidatedWithOriginServer": {
+ "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
+ "type": "boolean"
+ }
+ }
},
"ListSinksResponse": {
"id": "ListSinksResponse",
@@ -1890,85 +602,12 @@
}
}
},
- "HttpRequest": {
+ "LabelDescriptor": {
+ "description": "A description of a label.",
"type": "object",
"properties": {
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "requestSize": {
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64",
- "type": "string"
- },
- "responseSize": {
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "format": "int64",
- "type": "string"
- },
- "requestUrl": {
- "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".",
- "type": "string"
- },
- "serverIp": {
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
- "type": "string"
- },
- "remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
- "type": "string"
- },
- "cacheLookup": {
- "description": "Whether or not a cache lookup was attempted.",
- "type": "boolean"
- },
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
- },
- "cacheValidatedWithOriginServer": {
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
- "type": "boolean"
- },
- "status": {
- "description": "The response code indicating the status of response. Examples: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "referer": {
- "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
- "type": "string"
- },
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "latency": {
- "type": "string",
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "format": "google-duration"
- },
- "cacheFillBytes": {
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "HttpRequest",
- "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message."
- },
- "LabelDescriptor": {
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
"valueType": {
+ "type": "string",
"enumDescriptions": [
"A variable-length string. This is the default.",
"Boolean; true or false.",
@@ -1979,27 +618,38 @@
"BOOL",
"INT64"
],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor",
- "description": "A description of a label.",
- "type": "object"
- },
- "MonitoredResourceDescriptor": {
- "properties": {
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
+ "description": "The type of data that can be assigned to the label."
+ },
+ "key": {
+ "description": "The label key.",
"type": "string"
},
"description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ }
+ },
+ "id": "LabelDescriptor"
+ },
+ "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"
+ },
+ "displayName": {
"type": "string",
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation."
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\"."
+ },
+ "description": {
+ "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"
+ "type": "string",
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters."
},
"labels": {
"description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
@@ -2007,23 +657,17 @@
"items": {
"$ref": "LabelDescriptor"
}
- },
- "name": {
- "type": "string",
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\"."
}
},
- "id": "MonitoredResourceDescriptor",
- "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
- "type": "object"
+ "id": "MonitoredResourceDescriptor"
},
"LogEntrySourceLocation": {
"description": "Additional information about the source code location that produced the log entry.",
"type": "object",
"properties": {
"file": {
- "type": "string",
- "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name."
+ "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.",
+ "type": "string"
},
"function": {
"description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).",
@@ -2054,20 +698,81 @@
}
},
"id": "ListLogEntriesResponse"
+ },
+ "LogLine": {
+ "description": "Application log line emitted while processing a request.",
+ "type": "object",
+ "properties": {
+ "severity": {
+ "type": "string",
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or a configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
+ "enum": [
+ "DEFAULT",
+ "DEBUG",
+ "INFO",
+ "NOTICE",
+ "WARNING",
+ "ERROR",
+ "CRITICAL",
+ "ALERT",
+ "EMERGENCY"
+ ],
+ "description": "Severity of this log entry."
+ },
+ "logMessage": {
+ "description": "App-provided log message.",
+ "type": "string"
+ },
+ "sourceLocation": {
+ "description": "Where in the source code this log message was written.",
+ "$ref": "SourceLocation"
+ },
+ "time": {
+ "description": "Approximate time when this log entry was made.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "LogLine"
+ },
+ "ListLogMetricsResponse": {
+ "description": "Result returned from ListLogMetrics.",
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "description": "A list of logs-based metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "LogMetric"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
+ }
+ },
+ "id": "ListLogMetricsResponse"
}
},
"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": "Logging",
"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"
},
@@ -2079,6 +784,9 @@
},
"https://www.googleapis.com/auth/logging.write": {
"description": "Submit log data for your projects"
+ },
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
}
}
}
@@ -2086,5 +794,1297 @@
"rootUrl": "https://logging.googleapis.com/",
"ownerDomain": "google.com",
"name": "logging",
- "batchPath": "batch"
+ "batchPath": "batch",
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google",
+ "resources": {
+ "billingAccounts": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs",
+ "id": "logging.billingAccounts.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ]
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "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."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "delete": {
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.delete",
+ "path": "v2/{+sinkName}",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ }
+ }
+ },
+ "list": {
+ "description": "Lists sinks.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "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",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "parent": {
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks",
+ "id": "logging.billingAccounts.sinks.list",
+ "path": "v2/{+parent}/sinks"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "id": "logging.billingAccounts.sinks.get",
+ "path": "v2/{+sinkName}",
+ "description": "Gets a sink.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ]
+ },
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ },
+ "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 false.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.billingAccounts.sinks.update",
+ "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "create": {
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.billingAccounts.sinks.create",
+ "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^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"
+ }
+ }
+ }
+ }
+ },
+ "folders": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "pattern": "^folders/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.folders.logs.delete"
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "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": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/logs",
+ "id": "logging.folders.logs.list",
+ "path": "v2/{+parent}/logs",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+$"
+ }
+ },
+ "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",
+ "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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "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}",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
+ },
+ "list": {
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^folders/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.folders.sinks.list"
+ },
+ "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": {
+ "pattern": "^folders/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.folders.sinks.get",
+ "description": "Gets a sink."
+ },
+ "update": {
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^folders/[^/]+/sinks/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}",
+ "id": "logging.folders.sinks.update",
+ "path": "v2/{+sinkName}",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ }
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "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": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "path": "v2/monitoredResourceDescriptors",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "pattern": "^organizations/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.organizations.logs.delete"
+ },
+ "list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/logs",
+ "id": "logging.organizations.logs.list",
+ "path": "v2/{+parent}/logs"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^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}",
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "path": "v2/{+parent}/sinks",
+ "id": "logging.organizations.sinks.list",
+ "description": "Lists sinks."
+ },
+ "get": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"."
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.organizations.sinks.get",
+ "description": "Gets a sink."
+ },
+ "update": {
+ "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}",
+ "id": "logging.organizations.sinks.update",
+ "path": "v2/{+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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/organizations/{organizationsId}/sinks",
+ "id": "logging.organizations.sinks.create",
+ "path": "v2/{+parent}/sinks"
+ }
+ }
+ }
+ }
+ },
+ "entries": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {},
+ "flatPath": "v2/entries:list",
+ "path": "v2/entries:list",
+ "id": "logging.entries.list",
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ }
+ },
+ "write": {
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2/entries:write",
+ "path": "v2/entries:write",
+ "id": "logging.entries.write",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ },
+ "description": "Writes log entries to Stackdriver Logging."
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/logs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/logs/{logsId}",
+ "path": "v2/{+logName}",
+ "id": "logging.projects.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2/projects/{projectsId}/logs",
+ "path": "v2/{+parent}/logs",
+ "id": "logging.projects.logs.list",
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET"
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "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": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.list",
+ "path": "v2/{+parent}/sinks"
+ },
+ "get": {
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.get"
+ },
+ "update": {
+ "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ },
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$",
+ "location": "path"
+ },
+ "uniqueWriterIdentity": {
+ "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 false.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2/{+sinkName}",
+ "id": "logging.projects.sinks.update"
+ },
+ "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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameters": {
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
+ "type": "boolean"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2/projects/{projectsId}/sinks",
+ "id": "logging.projects.sinks.create",
+ "path": "v2/{+parent}/sinks"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "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."
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2/{+metricName}",
+ "id": "logging.projects.metrics.delete",
+ "description": "Deletes a logs-based metric."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics",
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "metricName": {
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.get",
+ "path": "v2/{+metricName}",
+ "description": "Gets a logs-based metric."
+ },
+ "update": {
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "metricName": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "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.update",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric."
+ },
+ "create": {
+ "path": "v2/{+parent}/metrics",
+ "id": "logging.projects.metrics.create",
+ "description": "Creates a logs-based metric.",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v2/projects/{projectsId}/metrics"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "type": "string",
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "callback": {
+ "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": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user."
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ }
+ },
+ "version": "v2",
+ "baseUrl": "https://logging.googleapis.com/",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "basePath": "",
+ "id": "logging:v2",
+ "documentationLink": "https://cloud.google.com/logging/docs/",
+ "revision": "20170306",
+ "discoveryVersion": "v1",
+ "version_module": "True"
}
diff --git a/logging/v2/logging-gen.go b/logging/v2/logging-gen.go
index 9924b63..c4c8e17 100644
--- a/logging/v2/logging-gen.go
+++ b/logging/v2/logging-gen.go
@@ -425,20 +425,21 @@
// 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 LogEntry.insertId.
+ // with equal timestamps are returned in order of their insert_id
+ // values.
OrderBy string `json:"orderBy,omitempty"`
// PageSize: 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
+ // next_page_token in the response indicates that more results might be
// available.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: 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.
+ // 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.
PageToken string `json:"pageToken,omitempty"`
// ProjectIds: Deprecated. Use resource_names instead. One or more
@@ -687,11 +688,13 @@
// with this log entry, if applicable.
HttpRequest *HttpRequest `json:"httpRequest,omitempty"`
- // InsertId: Optional. A unique ID for the log entry. If you provide
- // this field, the logging service considers other log entries in the
- // same project with the same ID as duplicates which can be removed. If
- // omitted, Stackdriver Logging will generate a unique ID for this log
- // entry.
+ // InsertId: 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 will insert its own unique
+ // identifier. The insert_id is used to order log entries that have the
+ // same timestamp value.
InsertId string `json:"insertId,omitempty"`
// JsonPayload: The log entry payload, represented as a structure that
@@ -765,8 +768,10 @@
TextPayload string `json:"textPayload,omitempty"`
// Timestamp: Optional. The time the event described by the log entry
- // occurred. If omitted, Stackdriver Logging will use the time the log
- // entry is received.
+ // occurred. If omitted in a new log entry, Stackdriver Logging will
+ // insert the time the log entry is received. Stackdriver Logging might
+ // reject log entries whose time stamps are more than a couple of hours
+ // in the future. Log entries with time stamps in the past are accepted.
Timestamp string `json:"timestamp,omitempty"`
// Trace: Optional. Resource name of the trace associated with the log
@@ -1445,11 +1450,15 @@
type WriteLogEntriesRequest struct {
// Entries: Required. The log entries to write. Values supplied for the
// fields log_name, resource, and labels in this entries.write request
- // are added to those log entries that do not provide their own values
- // for the fields.To improve throughput and to avoid exceeding the quota
- // limit for calls to entries.write, you should write multiple log
- // entries at once rather than calling this method for each individual
- // log entry.
+ // are inserted into those log entries in this list that do not provide
+ // their own values.Stackdriver Logging also creates and inserts values
+ // for timestamp and insert_id if the entries do not provide them. The
+ // created insert_id for the N'th entry in this list will be greater
+ // than earlier entries and less than later entries. Otherwise, the
+ // order of log entries in this list does not matter.To improve
+ // throughput and to avoid exceeding the quota limit for calls to
+ // entries.write, you should write multiple log entries at once rather
+ // than calling this method for each individual log entry.
Entries []*LogEntry `json:"entries,omitempty"`
// Labels: Optional. Default labels that are added to the labels field
@@ -1475,10 +1484,10 @@
// PartialSuccess: 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, the response
- // status will be the error associated with one of the failed entries
- // and include error details in the form of
- // WriteLogEntriesPartialErrors.
+ // 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.
PartialSuccess bool `json:"partialSuccess,omitempty"`
// Resource: Optional. A default monitored resource object that is
@@ -2794,8 +2803,7 @@
header_ http.Header
}
-// Write: Writes log entries to Stackdriver Logging. All log entries are
-// written by this method.
+// Write: Writes log entries to Stackdriver Logging.
func (r *EntriesService) Write(writelogentriesrequest *WriteLogEntriesRequest) *EntriesWriteCall {
c := &EntriesWriteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.writelogentriesrequest = writelogentriesrequest
@@ -2886,7 +2894,7 @@
}
return ret, nil
// {
- // "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
+ // "description": "Writes log entries to Stackdriver Logging.",
// "flatPath": "v2/entries:write",
// "httpMethod": "POST",
// "id": "logging.entries.write",
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json
index 5303c72..71bf5e8 100644
--- a/logging/v2beta1/logging-api.json
+++ b/logging/v2beta1/logging-api.json
@@ -1,751 +1,377 @@
{
- "ownerDomain": "google.com",
- "name": "logging",
- "batchPath": "batch",
- "title": "Stackdriver Logging API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "metrics": {
- "methods": {
- "list": {
- "description": "Lists logs-based metrics.",
- "response": {
- "$ref": "ListLogMetricsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_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": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "path": "v2beta1/{+parent}/metrics",
- "id": "logging.projects.metrics.list"
- },
- "get": {
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.get",
- "path": "v2beta1/{+metricName}",
- "description": "Gets a logs-based metric.",
- "httpMethod": "GET",
- "parameterOrder": [
- "metricName"
- ],
- "response": {
- "$ref": "LogMetric"
- },
- "parameters": {
- "metricName": {
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path",
- "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ]
- },
- "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": {
- "location": "path",
- "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "path": "v2beta1/{+metricName}",
- "id": "logging.projects.metrics.update",
- "description": "Creates or updates a logs-based metric.",
- "request": {
- "$ref": "LogMetric"
- }
- },
- "create": {
- "description": "Creates a logs-based metric.",
- "request": {
- "$ref": "LogMetric"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "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": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/metrics",
- "id": "logging.projects.metrics.create",
- "path": "v2beta1/{+parent}/metrics"
- },
- "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",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metrics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.write"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
- "id": "logging.projects.metrics.delete",
- "path": "v2beta1/{+metricName}",
- "description": "Deletes a logs-based metric."
- }
- }
- },
- "logs": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "logName": {
- "pattern": "^projects/[^/]+/logs/[^/]+$",
- "location": "path",
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
- "path": "v2beta1/{+logName}",
- "id": "logging.projects.logs.delete",
- "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
- },
- "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",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/projects/{projectsId}/logs",
- "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."
- }
- }
- },
- "sinks": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "path": "v2beta1/{+sinkName}",
- "id": "logging.projects.sinks.delete",
- "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
- },
- "list": {
- "flatPath": "v2beta1/projects/{projectsId}/sinks",
- "path": "v2beta1/{+parent}/sinks",
- "id": "logging.projects.sinks.list",
- "description": "Lists sinks.",
- "response": {
- "$ref": "ListSinksResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string"
- }
- }
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "LogSink"
- },
- "parameterOrder": [
- "sinkName"
- ],
- "parameters": {
- "sinkName": {
- "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
- "id": "logging.projects.sinks.get",
- "path": "v2beta1/{+sinkName}",
- "description": "Gets a sink."
- },
- "update": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "sinkName"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "sinkName": {
- "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/sinks/[^/]+$",
- "location": "path"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
- "type": "boolean"
- }
- },
- "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}",
- "request": {
- "$ref": "LogSink"
- },
- "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field."
- },
- "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 current time is outside the sink's start and end times or the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "LogSink"
- },
- "parameters": {
- "parent": {
- "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\".",
- "required": true,
- "type": "string"
- },
- "uniqueWriterIdentity": {
- "location": "query",
- "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "flatPath": "v2beta1/projects/{projectsId}/sinks",
- "id": "logging.projects.sinks.create",
- "path": "v2beta1/{+parent}/sinks"
- }
- }
- }
- }
- },
- "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"
- },
- "parameterOrder": [
- "logName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/logging.admin"
- ],
- "parameters": {
- "logName": {
- "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
- "path": "v2beta1/{+logName}",
- "id": "logging.billingAccounts.logs.delete"
- },
- "list": {
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "parent": {
- "required": true,
- "type": "string",
- "pattern": "^billingAccounts/[^/]+$",
- "location": "path",
- "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"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.billingAccounts.logs.list",
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed."
- }
- }
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- }
- },
- "flatPath": "v2beta1/monitoredResourceDescriptors",
- "id": "logging.monitoredResourceDescriptors.list",
- "path": "v2beta1/monitoredResourceDescriptors",
- "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging."
- }
- }
- },
- "organizations": {
- "resources": {
- "logs": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "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.",
- "required": true,
- "type": "string",
- "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."
- },
- "list": {
- "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
- "response": {
- "$ref": "ListLogsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
- "required": true,
- "type": "string",
- "pattern": "^organizations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/logging.admin",
- "https://www.googleapis.com/auth/logging.read"
- ],
- "flatPath": "v2beta1/organizations/{organizationsId}/logs",
- "path": "v2beta1/{+parent}/logs",
- "id": "logging.organizations.logs.list"
- }
- }
- }
- }
- },
- "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": "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"
- }
- },
- "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": "v2beta1/entries:write",
- "path": "v2beta1/entries:write",
- "id": "logging.entries.write",
- "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
- "request": {
- "$ref": "WriteLogEntriesRequest"
- }
- }
- }
- }
- },
- "parameters": {
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "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": "v2beta1",
- "baseUrl": "https://logging.googleapis.com/",
- "description": "Writes log entries and manages your Stackdriver Logging configuration.",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "basePath": "",
- "revision": "20170228",
"documentationLink": "https://cloud.google.com/logging/docs/",
+ "revision": "20170306",
"id": "logging:v2beta1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Empty": {
+ "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": {},
- "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 {}."
+ "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 Cloud SQL database is \"cloudsql_database\".",
+ "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, Cloud SQL databases use the labels \"database_id\" and \"zone\"."
+ }
+ },
+ "id": "MonitoredResource"
+ },
+ "WriteLogEntriesRequest": {
+ "type": "object",
+ "properties": {
+ "resource": {
+ "$ref": "MonitoredResource",
+ "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry."
+ },
+ "logName": {
+ "type": "string",
+ "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
+ },
+ "entries": {
+ "description": "Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are inserted into those log entries in this list that do not provide their own values.Stackdriver Logging also creates and inserts values for timestamp and insert_id if the entries do not provide them. The created insert_id for the N'th entry in this list will be greater than earlier entries and less than later entries. Otherwise, the order of log entries in this list does not matter.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.",
+ "type": "array",
+ "items": {
+ "$ref": "LogEntry"
+ }
+ },
+ "partialSuccess": {
+ "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.",
+ "type": "boolean"
+ },
+ "labels": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry."
+ }
+ },
+ "id": "WriteLogEntriesRequest",
+ "description": "The parameters to WriteLogEntries."
+ },
+ "LogSink": {
+ "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.",
+ "type": "object",
+ "properties": {
+ "filter": {
+ "description": "Optional. An advanced logs filter. The only exported log entries are those that are in the resource owning the sink and that match the filter. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
+ "type": "string"
+ },
+ "destination": {
+ "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "writerIdentity": {
+ "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "outputVersionFormat": {
+ "enum": [
+ "VERSION_FORMAT_UNSPECIFIED",
+ "V2",
+ "V1"
+ ],
+ "description": "Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified format version that will default to V2.",
+ "LogEntry version 2 format.",
+ "LogEntry version 1 format."
+ ]
+ },
+ "name": {
+ "type": "string",
+ "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods."
+ }
+ },
+ "id": "LogSink"
+ },
+ "ListLogsResponse": {
+ "description": "Result returned from ListLogs.",
+ "type": "object",
+ "properties": {
+ "logNames": {
+ "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "nextPageToken": {
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
+ "type": "string"
+ }
+ },
+ "id": "ListLogsResponse"
+ },
+ "ListSinksResponse": {
+ "description": "Result returned from ListSinks.",
+ "type": "object",
+ "properties": {
+ "sinks": {
+ "description": "A list of sinks.",
+ "type": "array",
+ "items": {
+ "$ref": "LogSink"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken."
+ }
+ },
+ "id": "ListSinksResponse"
+ },
+ "HttpRequest": {
+ "type": "object",
+ "properties": {
+ "cacheFillBytes": {
+ "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestMethod": {
+ "type": "string",
+ "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\"."
+ },
+ "responseSize": {
+ "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestSize": {
+ "type": "string",
+ "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
+ "format": "int64"
+ },
+ "requestUrl": {
+ "type": "string",
+ "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\"."
+ },
+ "serverIp": {
+ "type": "string",
+ "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to."
+ },
+ "remoteIp": {
+ "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
+ "type": "string"
+ },
+ "cacheLookup": {
+ "description": "Whether or not a cache lookup was attempted.",
+ "type": "boolean"
+ },
+ "cacheHit": {
+ "description": "Whether or not an entity was served from cache (with or without validation).",
+ "type": "boolean"
+ },
+ "cacheValidatedWithOriginServer": {
+ "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."
+ },
+ "status": {
+ "type": "integer",
+ "description": "The response code indicating the status of response. Examples: 200, 404.",
+ "format": "int32"
+ },
+ "referer": {
+ "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).",
+ "type": "string"
+ },
+ "userAgent": {
+ "type": "string",
+ "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"."
+ },
+ "latency": {
+ "type": "string",
+ "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
+ "format": "google-duration"
+ }
+ },
+ "id": "HttpRequest",
+ "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message."
+ },
+ "LabelDescriptor": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "A human-readable description for the label."
+ },
+ "valueType": {
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string",
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ]
+ }
+ },
+ "id": "LabelDescriptor",
+ "description": "A description of a label."
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\"."
+ },
+ "displayName": {
+ "type": "string",
+ "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\"."
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "LogEntrySourceLocation": {
+ "description": "Additional information about the source code location that produced the log entry.",
+ "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": {
+ "type": "string",
+ "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python)."
+ },
+ "line": {
+ "type": "string",
+ "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
+ "format": "int64"
+ }
+ },
+ "id": "LogEntrySourceLocation"
+ },
+ "ListLogEntriesResponse": {
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search."
+ },
+ "entries": {
+ "description": "A list of log entries.",
+ "type": "array",
+ "items": {
+ "$ref": "LogEntry"
+ }
+ }
+ },
+ "id": "ListLogEntriesResponse",
+ "description": "Result returned from ListLogEntries."
+ },
+ "LogLine": {
+ "type": "object",
+ "properties": {
+ "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."
+ ]
+ },
+ "logMessage": {
+ "description": "App-provided log message.",
+ "type": "string"
+ },
+ "sourceLocation": {
+ "$ref": "SourceLocation",
+ "description": "Where in the source code this log message was written."
+ },
+ "time": {
+ "description": "Approximate time when this log entry was made.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "LogLine",
+ "description": "Application log line emitted while processing a request."
+ },
+ "ListLogMetricsResponse": {
+ "type": "object",
+ "properties": {
+ "metrics": {
+ "description": "A list of logs-based metrics.",
+ "type": "array",
+ "items": {
+ "$ref": "LogMetric"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
+ }
+ },
+ "id": "ListLogMetricsResponse",
+ "description": "Result returned from ListLogMetrics."
},
"LogEntry": {
"description": "An individual entry in a log.",
"type": "object",
"properties": {
- "timestamp": {
- "description": "Optional. The time the event described by the log entry occurred. If omitted, Stackdriver Logging will use the time the log entry is received.",
- "format": "google-datetime",
- "type": "string"
- },
- "logName": {
- "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
- "type": "string"
- },
"httpRequest": {
"$ref": "HttpRequest",
"description": "Optional. Information about the HTTP request associated with this log entry, if applicable."
@@ -762,17 +388,17 @@
"description": "The log entry payload, represented as a structure that is expressed as a JSON object.",
"type": "object"
},
- "operation": {
- "description": "Optional. Information about an operation associated with the log entry, if applicable.",
- "$ref": "LogEntryOperation"
- },
"insertId": {
"type": "string",
- "description": "Optional. A unique ID for the log entry. If you provide this field, the logging service considers other log entries in the same project with the same ID as duplicates which can be removed. If omitted, Stackdriver Logging will generate a unique ID for this log entry."
+ "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 will insert its own unique identifier. The insert_id is used to order log entries that have the same timestamp value."
+ },
+ "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"
+ "type": "string",
+ "description": "The log entry payload, represented as a Unicode string (UTF-8)."
},
"protoPayload": {
"additionalProperties": {
@@ -783,18 +409,17 @@
"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"
+ "type": "string",
+ "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824"
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.",
- "type": "object"
+ "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry."
},
"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.",
@@ -817,15 +442,31 @@
"CRITICAL",
"ALERT",
"EMERGENCY"
- ]
+ ],
+ "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT."
},
"sourceLocation": {
- "description": "Optional. Source code location information associated with the log entry, if any.",
- "$ref": "LogEntrySourceLocation"
+ "$ref": "LogEntrySourceLocation",
+ "description": "Optional. Source code location information associated with the log entry, if any."
+ },
+ "timestamp": {
+ "type": "string",
+ "description": "Optional. The time the event described by the log entry occurred. If omitted in a new log entry, Stackdriver Logging will insert the time the log entry is received. Stackdriver Logging might reject log entries whose time stamps are more than a couple of hours in the future. Log entries with time stamps in the past are accepted.",
+ "format": "google-datetime"
+ },
+ "logName": {
+ "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.",
+ "type": "string"
}
},
"id": "LogEntry"
},
+ "Empty": {
+ "type": "object",
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}."
+ },
"SourceLocation": {
"description": "Specifies a location in a source code file.",
"type": "object",
@@ -835,8 +476,8 @@
"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"
+ "type": "string",
+ "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python)."
},
"line": {
"description": "Line within the source file.",
@@ -849,19 +490,6 @@
"ListLogEntriesRequest": {
"type": "object",
"properties": {
- "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"
- },
- "pageSize": {
- "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
- "format": "int32",
- "type": "integer"
- },
- "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 LogEntry.insertId.",
- "type": "string"
- },
"resourceNames": {
"description": "Required. Names of one or more parent resources from which to retrieve log entries:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nProjects listed in the project_ids field are added to this list.",
"type": "array",
@@ -879,16 +507,41 @@
"filter": {
"description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.",
"type": "string"
+ },
+ "pageToken": {
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "orderBy": {
+ "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.",
+ "type": "string"
}
},
"id": "ListLogEntriesRequest",
"description": "The parameters to ListLogEntries."
},
"RequestLog": {
- "id": "RequestLog",
"description": "Complete log information about a single HTTP request to an App Engine application.",
"type": "object",
"properties": {
+ "instanceIndex": {
+ "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "finished": {
+ "type": "boolean",
+ "description": "Whether this request is finished or active."
+ },
+ "host": {
+ "type": "string",
+ "description": "Internet host and port number of the resource being requested."
+ },
"httpVersion": {
"description": "HTTP version of request. Example: \"HTTP/1.1\".",
"type": "string"
@@ -899,21 +552,21 @@
"type": "string"
},
"latency": {
+ "type": "string",
"description": "Latency of the request.",
- "format": "google-duration",
- "type": "string"
+ "format": "google-duration"
},
"ip": {
- "description": "Origin IP address.",
- "type": "string"
+ "type": "string",
+ "description": "Origin IP address."
},
"appId": {
- "description": "Application that handled this request.",
- "type": "string"
+ "type": "string",
+ "description": "Application that handled this request."
},
"appEngineRelease": {
- "description": "App Engine release version.",
- "type": "string"
+ "type": "string",
+ "description": "App Engine release version."
},
"method": {
"description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".",
@@ -925,8 +578,8 @@
"type": "number"
},
"instanceId": {
- "description": "An identifier for the instance that handled the request.",
- "type": "string"
+ "type": "string",
+ "description": "An identifier for the instance that handled the request."
},
"megaCycles": {
"description": "Number of CPU megacycles used to process request.",
@@ -951,19 +604,19 @@
"type": "string"
},
"userAgent": {
- "description": "User agent that made the request.",
- "type": "string"
+ "type": "string",
+ "description": "User agent that made the request."
},
"wasLoadingRequest": {
"description": "Whether this was a loading request for the instance.",
"type": "boolean"
},
"sourceReference": {
- "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.",
"type": "array",
"items": {
"$ref": "SourceReference"
- }
+ },
+ "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories."
},
"responseSize": {
"description": "Size in bytes sent back to client by request.",
@@ -975,41 +628,41 @@
"type": "string"
},
"line": {
- "description": "A list of log lines emitted by the application while serving this request.",
"type": "array",
"items": {
"$ref": "LogLine"
- }
- },
- "referrer": {
- "description": "Referrer URL of request.",
- "type": "string"
+ },
+ "description": "A list of log lines emitted by the application while serving this request."
},
"taskQueueName": {
- "description": "Queue name of the request, in the case of an offline request.",
- "type": "string"
+ "type": "string",
+ "description": "Queue name of the request, in the case of an offline request."
+ },
+ "referrer": {
+ "type": "string",
+ "description": "Referrer URL of request."
},
"requestId": {
- "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.",
- "type": "string"
+ "type": "string",
+ "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier."
},
"nickname": {
"type": "string",
"description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21."
},
"status": {
+ "type": "integer",
"description": "HTTP response status code. Example: 200, 404.",
- "format": "int32",
- "type": "integer"
+ "format": "int32"
},
"resource": {
"description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.",
"type": "string"
},
"pendingTime": {
+ "type": "string",
"description": "Time this request spent in the pending request queue.",
- "format": "google-duration",
- "type": "string"
+ "format": "google-duration"
},
"taskName": {
"description": "Task name of the request, in the case of an offline request.",
@@ -1018,36 +671,24 @@
"urlMapEntry": {
"description": "File or class that handled the request.",
"type": "string"
- },
- "instanceIndex": {
- "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.",
- "format": "int32",
- "type": "integer"
- },
- "finished": {
- "description": "Whether this request is finished or active.",
- "type": "boolean"
- },
- "host": {
- "description": "Internet host and port number of the resource being requested.",
- "type": "string"
}
- }
+ },
+ "id": "RequestLog"
},
"ListMonitoredResourceDescriptorsResponse": {
"description": "Result returned from ListMonitoredResourceDescriptors.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- },
"resourceDescriptors": {
"description": "A list of resource descriptors.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
}
+ },
+ "nextPageToken": {
+ "type": "string",
+ "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken."
}
},
"id": "ListMonitoredResourceDescriptorsResponse"
@@ -1056,34 +697,51 @@
"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\"",
- "type": "string"
- },
"repository": {
"description": "Optional. A URI string identifying the repository. Example: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"",
"type": "string"
+ },
+ "revisionId": {
+ "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"",
+ "type": "string"
}
},
"id": "SourceReference"
},
- "WriteLogEntriesResponse": {
- "properties": {},
- "id": "WriteLogEntriesResponse",
- "description": "Result returned from WriteLogEntries. empty",
- "type": "object"
+ "LogMetric": {
+ "type": "object",
+ "properties": {
+ "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": {
+ "description": "Optional. A description of this metric, which is used in documentation.",
+ "type": "string"
+ },
+ "version": {
+ "enum": [
+ "V2",
+ "V1"
+ ],
+ "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.",
+ "type": "string",
+ "enumDescriptions": [
+ "Stackdriver Logging API v2.",
+ "Stackdriver Logging API v1."
+ ]
+ },
+ "filter": {
+ "type": "string",
+ "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters."
+ }
+ },
+ "id": "LogMetric",
+ "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval."
},
"LogEntryOperation": {
"type": "object",
"properties": {
- "producer": {
- "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\".",
- "type": "string"
- },
- "first": {
- "description": "Optional. Set this to True if this is the first log entry in the operation.",
- "type": "boolean"
- },
"last": {
"description": "Optional. Set this to True if this is the last log entry in the operation.",
"type": "boolean"
@@ -1091,411 +749,31 @@
"id": {
"description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.",
"type": "string"
+ },
+ "producer": {
+ "type": "string",
+ "description": "Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: \"MyDivision.MyBigCompany.com\", \"github.com/MyProject/MyApplication\"."
+ },
+ "first": {
+ "type": "boolean",
+ "description": "Optional. Set this to True if this is the first log entry in the operation."
}
},
"id": "LogEntryOperation",
"description": "Additional information about a potentially long-running operation with which a log entry is associated."
},
- "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.",
+ "WriteLogEntriesResponse": {
"type": "object",
- "properties": {
- "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"
- },
- "description": {
- "description": "Optional. A description of this metric, which is used in documentation.",
- "type": "string"
- },
- "version": {
- "description": "Output only. The API version that created or updated this metric. The version also dictates the syntax of the filter expression. When a value for this field is missing, the default value of V2 should be assumed.",
- "type": "string",
- "enumDescriptions": [
- "Stackdriver Logging API v2.",
- "Stackdriver Logging API v1."
- ],
- "enum": [
- "V2",
- "V1"
- ]
- },
- "filter": {
- "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.",
- "type": "string"
- }
- },
- "id": "LogMetric"
- },
- "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 Cloud SQL database is \"cloudsql_database\".",
- "type": "string"
- },
- "labels": {
- "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels \"database_id\" and \"zone\".",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "id": "MonitoredResource"
- },
- "WriteLogEntriesRequest": {
- "description": "The parameters to WriteLogEntries.",
- "type": "object",
- "properties": {
- "logName": {
- "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
- "type": "string"
- },
- "entries": {
- "description": "Required. The log entries to write. Values supplied for the fields log_name, resource, and labels in this entries.write request are added to those log entries that do not provide their own values for the fields.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should write multiple log entries at once rather than calling this method for each individual log entry.",
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- }
- },
- "partialSuccess": {
- "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, the response status will be the error associated with one of the failed entries and include error details in the form of WriteLogEntriesPartialErrors.",
- "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"
- },
- "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": {
- "startTime": {
- "description": "Optional. The time at which this sink will begin exporting log entries. Log entries are exported only if their timestamp is not earlier than the start time. The default value of this field is the time the sink is created or updated.",
- "format": "google-datetime",
- "type": "string"
- },
- "writerIdentity": {
- "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.",
- "type": "string"
- },
- "outputVersionFormat": {
- "type": "string",
- "enumDescriptions": [
- "An unspecified format version that will default to V2.",
- "LogEntry version 2 format.",
- "LogEntry version 1 format."
- ],
- "enum": [
- "VERSION_FORMAT_UNSPECIFIED",
- "V2",
- "V1"
- ],
- "description": "Optional. The log entry format to use for this sink's exported log entries. The v2 format is used by default. The v1 format is deprecated and should be used only as part of a migration effort to v2. See Migration to the v2 API."
- },
- "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"
- },
- "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. The filter must use the log entry format specified by the output_version_format parameter. For example, in the v2 format:\nlogName=\"projects/[PROJECT_ID]/logs/[LOG_ID]\" AND severity\u003e=ERROR\n",
- "type": "string"
- },
- "destination": {
- "description": "Required. The export destination:\n\"storage.googleapis.com/[GCS_BUCKET]\"\n\"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"\n\"pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]\"\nThe sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs With Sinks.",
- "type": "string"
- },
- "endTime": {
- "description": "Optional. The time at which this sink will stop exporting log entries. Log entries are exported only if their timestamp is earlier than the end time. If this field is not supplied, there is no end time. If both a start time and an end time are provided, then the end time must be later than the start time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "LogSink"
- },
- "ListLogsResponse": {
- "description": "Result returned from ListLogs.",
- "type": "object",
- "properties": {
- "logNames": {
- "description": "A list of log names. For example, \"projects/my-project/syslog\" or \"organizations/123/cloudresourcemanager.googleapis.com%2Factivity\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- },
- "id": "ListLogsResponse"
- },
- "ListSinksResponse": {
- "id": "ListSinksResponse",
- "description": "Result returned from ListSinks.",
- "type": "object",
- "properties": {
- "sinks": {
- "description": "A list of sinks.",
- "type": "array",
- "items": {
- "$ref": "LogSink"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- }
- },
- "HttpRequest": {
- "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.",
- "type": "object",
- "properties": {
- "userAgent": {
- "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".",
- "type": "string"
- },
- "latency": {
- "description": "The request processing latency on the server, from the time the request was received until the response was sent.",
- "format": "google-duration",
- "type": "string"
- },
- "cacheFillBytes": {
- "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.",
- "format": "int64",
- "type": "string"
- },
- "requestMethod": {
- "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".",
- "type": "string"
- },
- "responseSize": {
- "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.",
- "format": "int64",
- "type": "string"
- },
- "requestSize": {
- "type": "string",
- "description": "The size of the HTTP request message in bytes, including the request headers and the request body.",
- "format": "int64"
- },
- "requestUrl": {
- "type": "string",
- "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\"."
- },
- "serverIp": {
- "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.",
- "type": "string"
- },
- "remoteIp": {
- "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".",
- "type": "string"
- },
- "cacheLookup": {
- "description": "Whether or not a cache lookup was attempted.",
- "type": "boolean"
- },
- "cacheHit": {
- "description": "Whether or not an entity was served from cache (with or without validation).",
- "type": "boolean"
- },
- "cacheValidatedWithOriginServer": {
- "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.",
- "type": "boolean"
- },
- "status": {
- "description": "The response code indicating the status of response. Examples: 200, 404.",
- "format": "int32",
- "type": "integer"
- },
- "referer": {
- "type": "string",
- "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)."
- }
- },
- "id": "HttpRequest"
- },
- "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"
- },
- "MonitoredResourceDescriptor": {
- "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.",
- "type": "object",
- "properties": {
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".",
- "type": "string"
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".",
- "type": "string"
- },
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.",
- "type": "string"
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "LogEntrySourceLocation": {
- "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": {
- "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.",
- "format": "int64",
- "type": "string"
- }
- },
- "id": "LogEntrySourceLocation",
- "description": "Additional information about the source code location that produced the log entry.",
- "type": "object"
- },
- "ListLogEntriesResponse": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "LogEntry"
- }
- }
- },
- "id": "ListLogEntriesResponse",
- "description": "Result returned from ListLogEntries.",
- "type": "object"
- },
- "LogLine": {
- "description": "Application log line emitted while processing a request.",
- "type": "object",
- "properties": {
- "severity": {
- "description": "Severity of this log entry.",
- "type": "string",
- "enumDescriptions": [
- "(0) The log entry has no assigned severity level.",
- "(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"
- ]
- },
- "logMessage": {
- "description": "App-provided log message.",
- "type": "string"
- },
- "sourceLocation": {
- "description": "Where in the source code this log message was written.",
- "$ref": "SourceLocation"
- },
- "time": {
- "description": "Approximate time when this log entry was made.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "LogLine"
- },
- "ListLogMetricsResponse": {
- "description": "Result returned from ListLogMetrics.",
- "type": "object",
- "properties": {
- "metrics": {
- "description": "A list of logs-based metrics.",
- "type": "array",
- "items": {
- "$ref": "LogMetric"
- }
- },
- "nextPageToken": {
- "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.",
- "type": "string"
- }
- },
- "id": "ListLogMetricsResponse"
+ "properties": {},
+ "id": "WriteLogEntriesResponse",
+ "description": "Result returned from WriteLogEntries. empty"
}
},
- "protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
+ "protocol": "rest",
"canonicalName": "Logging",
"auth": {
"oauth2": {
@@ -1518,5 +796,727 @@
}
}
},
- "rootUrl": "https://logging.googleapis.com/"
+ "rootUrl": "https://logging.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "logging",
+ "batchPath": "batch",
+ "title": "Stackdriver Logging API",
+ "ownerName": "Google",
+ "resources": {
+ "entries": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/entries:list",
+ "path": "v2beta1/entries:list",
+ "id": "logging.entries.list",
+ "request": {
+ "$ref": "ListLogEntriesRequest"
+ },
+ "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.",
+ "response": {
+ "$ref": "ListLogEntriesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "write": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "WriteLogEntriesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {},
+ "flatPath": "v2beta1/entries:write",
+ "id": "logging.entries.write",
+ "path": "v2beta1/entries:write",
+ "description": "Writes log entries to Stackdriver Logging.",
+ "request": {
+ "$ref": "WriteLogEntriesRequest"
+ }
+ }
+ }
+ },
+ "projects": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "logName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^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."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}",
+ "id": "logging.projects.logs.delete",
+ "path": "v2beta1/{+logName}",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ },
+ "list": {
+ "flatPath": "v2beta1/projects/{projectsId}/logs",
+ "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.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ },
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ }
+ }
+ },
+ "sinks": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.delete",
+ "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted."
+ },
+ "list": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "path": "v2beta1/{+parent}/sinks",
+ "id": "logging.projects.sinks.list",
+ "description": "Lists sinks.",
+ "response": {
+ "$ref": "ListSinksResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ },
+ "get": {
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.get",
+ "description": "Gets a sink.",
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "parameters": {
+ "sinkName": {
+ "required": true,
+ "type": "string",
+ "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\"."
+ }
+ }
+ },
+ "update": {
+ "response": {
+ "$ref": "LogSink"
+ },
+ "parameterOrder": [
+ "sinkName"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "sinkName": {
+ "location": "path",
+ "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/sinks/[^/]+$"
+ },
+ "uniqueWriterIdentity": {
+ "location": "query",
+ "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is false.",
+ "type": "boolean"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}",
+ "path": "v2beta1/{+sinkName}",
+ "id": "logging.projects.sinks.update",
+ "description": "Updates a sink. If the named sink doesn't exist, then this method is identical to sinks.create. If the named sink does exist, then this method replaces the following fields in the existing sink with values from the new sink: destination, filter, output_version_format, start_time, and end_time. The updated filter might also have a new writer_identity; see the unique_writer_identity field.",
+ "request": {
+ "$ref": "LogSink"
+ }
+ },
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\"."
+ },
+ "uniqueWriterIdentity": {
+ "type": "boolean",
+ "location": "query",
+ "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink."
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/sinks",
+ "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 current time is outside the sink's start and end times or 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"
+ }
+ }
+ }
+ },
+ "metrics": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListLogMetricsResponse"
+ },
+ "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": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "path": "v2beta1/{+parent}/metrics",
+ "id": "logging.projects.metrics.list",
+ "description": "Lists logs-based metrics."
+ },
+ "get": {
+ "description": "Gets a logs-based metric.",
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameterOrder": [
+ "metricName"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "path": "v2beta1/{+metricName}",
+ "id": "logging.projects.metrics.get"
+ },
+ "update": {
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.update",
+ "path": "v2beta1/{+metricName}",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates or updates a logs-based metric.",
+ "httpMethod": "PUT",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameters": {
+ "metricName": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ]
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "LogMetric"
+ },
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "flatPath": "v2beta1/projects/{projectsId}/metrics",
+ "id": "logging.projects.metrics.create",
+ "path": "v2beta1/{+parent}/metrics",
+ "request": {
+ "$ref": "LogMetric"
+ },
+ "description": "Creates a logs-based metric."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "metricName"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.write"
+ ],
+ "parameters": {
+ "metricName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metrics/[^/]+$",
+ "location": "path",
+ "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n"
+ }
+ },
+ "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}",
+ "id": "logging.projects.metrics.delete",
+ "path": "v2beta1/{+metricName}",
+ "description": "Deletes a logs-based metric."
+ }
+ }
+ }
+ }
+ },
+ "billingAccounts": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ },
+ "parent": {
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n",
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+$"
+ }
+ },
+ "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."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "logName": {
+ "required": true,
+ "type": "string",
+ "pattern": "^billingAccounts/[^/]+/logs/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}",
+ "path": "v2beta1/{+logName}",
+ "id": "logging.billingAccounts.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ }
+ }
+ }
+ }
+ },
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "flatPath": "v2beta1/monitoredResourceDescriptors",
+ "path": "v2beta1/monitoredResourceDescriptors",
+ "id": "logging.monitoredResourceDescriptors.list",
+ "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.",
+ "response": {
+ "$ref": "ListMonitoredResourceDescriptorsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "pageToken": {
+ "type": "string",
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call."
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ]
+ }
+ }
+ },
+ "organizations": {
+ "resources": {
+ "logs": {
+ "methods": {
+ "list": {
+ "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.",
+ "response": {
+ "$ref": "ListLogsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+$",
+ "location": "path",
+ "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.",
+ "format": "int32"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/logging.admin",
+ "https://www.googleapis.com/auth/logging.read"
+ ],
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs",
+ "path": "v2beta1/{+parent}/logs",
+ "id": "logging.organizations.logs.list"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "logName"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/logging.admin"
+ ],
+ "parameters": {
+ "logName": {
+ "location": "path",
+ "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.",
+ "required": true,
+ "type": "string",
+ "pattern": "^organizations/[^/]+/logs/[^/]+$"
+ }
+ },
+ "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}",
+ "path": "v2beta1/{+logName}",
+ "id": "logging.organizations.logs.delete",
+ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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"
+ },
+ "alt": {
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth bearer token."
+ },
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ }
+ },
+ "version": "v2beta1",
+ "baseUrl": "https://logging.googleapis.com/",
+ "servicePath": "",
+ "description": "Writes log entries and manages your Stackdriver Logging configuration.",
+ "kind": "discovery#restDescription",
+ "basePath": ""
}
diff --git a/logging/v2beta1/logging-gen.go b/logging/v2beta1/logging-gen.go
index 78555ea..bddc718 100644
--- a/logging/v2beta1/logging-gen.go
+++ b/logging/v2beta1/logging-gen.go
@@ -365,20 +365,21 @@
// 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 LogEntry.insertId.
+ // with equal timestamps are returned in order of their insert_id
+ // values.
OrderBy string `json:"orderBy,omitempty"`
// PageSize: 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
+ // next_page_token in the response indicates that more results might be
// available.
PageSize int64 `json:"pageSize,omitempty"`
// PageToken: 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.
+ // 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.
PageToken string `json:"pageToken,omitempty"`
// ProjectIds: Deprecated. Use resource_names instead. One or more
@@ -627,11 +628,13 @@
// with this log entry, if applicable.
HttpRequest *HttpRequest `json:"httpRequest,omitempty"`
- // InsertId: Optional. A unique ID for the log entry. If you provide
- // this field, the logging service considers other log entries in the
- // same project with the same ID as duplicates which can be removed. If
- // omitted, Stackdriver Logging will generate a unique ID for this log
- // entry.
+ // InsertId: 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 will insert its own unique
+ // identifier. The insert_id is used to order log entries that have the
+ // same timestamp value.
InsertId string `json:"insertId,omitempty"`
// JsonPayload: The log entry payload, represented as a structure that
@@ -705,8 +708,10 @@
TextPayload string `json:"textPayload,omitempty"`
// Timestamp: Optional. The time the event described by the log entry
- // occurred. If omitted, Stackdriver Logging will use the time the log
- // entry is received.
+ // occurred. If omitted in a new log entry, Stackdriver Logging will
+ // insert the time the log entry is received. Stackdriver Logging might
+ // reject log entries whose time stamps are more than a couple of hours
+ // in the future. Log entries with time stamps in the past are accepted.
Timestamp string `json:"timestamp,omitempty"`
// Trace: Optional. Resource name of the trace associated with the log
@@ -1385,11 +1390,15 @@
type WriteLogEntriesRequest struct {
// Entries: Required. The log entries to write. Values supplied for the
// fields log_name, resource, and labels in this entries.write request
- // are added to those log entries that do not provide their own values
- // for the fields.To improve throughput and to avoid exceeding the quota
- // limit for calls to entries.write, you should write multiple log
- // entries at once rather than calling this method for each individual
- // log entry.
+ // are inserted into those log entries in this list that do not provide
+ // their own values.Stackdriver Logging also creates and inserts values
+ // for timestamp and insert_id if the entries do not provide them. The
+ // created insert_id for the N'th entry in this list will be greater
+ // than earlier entries and less than later entries. Otherwise, the
+ // order of log entries in this list does not matter.To improve
+ // throughput and to avoid exceeding the quota limit for calls to
+ // entries.write, you should write multiple log entries at once rather
+ // than calling this method for each individual log entry.
Entries []*LogEntry `json:"entries,omitempty"`
// Labels: Optional. Default labels that are added to the labels field
@@ -1415,10 +1424,10 @@
// PartialSuccess: 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, the response
- // status will be the error associated with one of the failed entries
- // and include error details in the form of
- // WriteLogEntriesPartialErrors.
+ // 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.
PartialSuccess bool `json:"partialSuccess,omitempty"`
// Resource: Optional. A default monitored resource object that is
@@ -1942,8 +1951,7 @@
header_ http.Header
}
-// Write: Writes log entries to Stackdriver Logging. All log entries are
-// written by this method.
+// Write: Writes log entries to Stackdriver Logging.
func (r *EntriesService) Write(writelogentriesrequest *WriteLogEntriesRequest) *EntriesWriteCall {
c := &EntriesWriteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.writelogentriesrequest = writelogentriesrequest
@@ -2034,7 +2042,7 @@
}
return ret, nil
// {
- // "description": "Writes log entries to Stackdriver Logging. All log entries are written by this method.",
+ // "description": "Writes log entries to Stackdriver Logging.",
// "flatPath": "v2beta1/entries:write",
// "httpMethod": "POST",
// "id": "logging.entries.write",
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json
index 80c9406..9d8c674 100644
--- a/manufacturers/v1/manufacturers-api.json
+++ b/manufacturers/v1/manufacturers-api.json
@@ -1,19 +1,4 @@
{
- "canonicalName": "Manufacturer Center",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/manufacturercenter": {
- "description": "Manage your product listings for Google Manufacturer Center"
- }
- }
- }
- },
- "rootUrl": "https://manufacturers.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "manufacturers",
- "batchPath": "batch",
- "title": "Manufacturer Center API",
"ownerName": "Google",
"resources": {
"accounts": {
@@ -21,7 +6,6 @@
"products": {
"methods": {
"list": {
- "description": "Lists all the products in a Manufacturer Center account.",
"response": {
"$ref": "ListProductsResponse"
},
@@ -34,27 +18,28 @@
],
"parameters": {
"pageToken": {
- "location": "query",
"description": "The token returned by the previous request.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"pageSize": {
- "location": "query",
"description": "Maximum number of product statuses to return in the response, used for\npaging.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"parent": {
+ "pattern": "^accounts/[^/]+$",
+ "location": "path",
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"required": true,
- "type": "string",
- "pattern": "^accounts/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"flatPath": "v1/accounts/{accountsId}/products",
"path": "v1/{+parent}/products",
- "id": "manufacturers.accounts.products.list"
+ "id": "manufacturers.accounts.products.list",
+ "description": "Lists all the products in a Manufacturer Center account."
},
"get": {
"parameterOrder": [
@@ -65,25 +50,25 @@
"response": {
"$ref": "Product"
},
- "scopes": [
- "https://www.googleapis.com/auth/manufacturercenter"
- ],
"parameters": {
+ "name": {
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
+ "required": true,
+ "type": "string"
+ },
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"required": true,
"type": "string",
"pattern": "^accounts/[^/]+$",
"location": "path"
- },
- "name": {
- "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/manufacturercenter"
+ ],
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"path": "v1/{+parent}/products/{+name}",
"id": "manufacturers.accounts.products.get",
@@ -95,26 +80,16 @@
}
},
"parameters": {
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"fields": {
"location": "query",
@@ -122,29 +97,35 @@
"type": "string"
},
"uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "callback": {
"location": "query",
- "description": "JSONP",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.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",
"Media download with context-dependent Content-Type",
@@ -152,45 +133,49 @@
],
"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"
+ "default": "json"
},
"access_token": {
"description": "OAuth access token.",
"type": "string",
"location": "query"
},
- "quotaUser": {
+ "key": {
"location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
"location": "query"
}
},
"version": "v1",
"baseUrl": "https://manufacturers.googleapis.com/",
- "kind": "discovery#restDescription",
"servicePath": "",
+ "kind": "discovery#restDescription",
"description": "Public API for managing Manufacturer Center related data.",
"basePath": "",
- "id": "manufacturers:v1",
- "revision": "20161028",
"documentationLink": "https://developers.google.com/manufacturers/",
+ "revision": "20161028",
+ "id": "manufacturers:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
@@ -198,7 +183,17 @@
"description": "Product issue.",
"type": "object",
"properties": {
+ "attribute": {
+ "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "string"
+ },
"severity": {
+ "enumDescriptions": [
+ "Unspecified severity, never used.",
+ "Error severity. The issue prevents the usage of the whole item.",
+ "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
+ "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
+ ],
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
@@ -206,13 +201,7 @@
"INFO"
],
"description": "The severity of the issue.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified severity, never used.",
- "Error severity. The issue prevents the usage of the whole item.",
- "Warning severity. The issue is either one that prevents the usage of the\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
- "Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
- ]
+ "type": "string"
},
"description": {
"description": "Description of the issue.",
@@ -221,17 +210,11 @@
"type": {
"description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
"type": "string"
- },
- "attribute": {
- "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "string"
}
},
"id": "Issue"
},
"Product": {
- "description": "Product data.",
- "type": "object",
"properties": {
"name": {
"description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
@@ -260,30 +243,38 @@
"type": "string"
},
"uploadedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds."
+ "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.",
+ "$ref": "Attributes"
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
"type": "string"
},
"manuallyProvidedAttributes": {
- "$ref": "Attributes",
- "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
- },
- "targetCountry": {
- "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
- "type": "string"
+ "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly",
+ "$ref": "Attributes"
},
"contentLanguage": {
"description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly",
"type": "string"
+ },
+ "targetCountry": {
+ "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly",
+ "type": "string"
}
},
- "id": "Product"
+ "id": "Product",
+ "description": "Product data.",
+ "type": "object"
},
"Attributes": {
+ "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
+ "type": "object",
"properties": {
+ "productName": {
+ "description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.",
+ "type": "string"
+ },
"productType": {
"description": "The manufacturer's category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
"type": "array",
@@ -291,14 +282,14 @@
"type": "string"
}
},
- "mpn": {
- "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
- "type": "string"
- },
"productPageUrl": {
"description": "The URL of the manufacturer's detail page of the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
"type": "string"
},
+ "mpn": {
+ "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
+ "type": "string"
+ },
"gtin": {
"description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.",
"type": "array",
@@ -317,29 +308,23 @@
"brand": {
"description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.",
"type": "string"
- },
- "productName": {
- "description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.",
- "type": "string"
}
},
- "id": "Attributes",
- "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
- "type": "object"
+ "id": "Attributes"
},
"ListProductsResponse": {
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of product statuses.",
- "type": "string"
- },
"products": {
"description": "List of the products.",
"type": "array",
"items": {
"$ref": "Product"
}
+ },
+ "nextPageToken": {
+ "description": "The token for the retrieval of the next page of product statuses.",
+ "type": "string"
}
},
"id": "ListProductsResponse"
@@ -349,5 +334,20 @@
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
- }
+ },
+ "canonicalName": "Manufacturer Center",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/manufacturercenter": {
+ "description": "Manage your product listings for Google Manufacturer Center"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://manufacturers.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "manufacturers",
+ "batchPath": "batch",
+ "title": "Manufacturer Center API"
}
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json
new file mode 100644
index 0000000..2a65ce3
--- /dev/null
+++ b/ml/v1/ml-api.json
@@ -0,0 +1,1550 @@
+{
+ "kind": "discovery#restDescription",
+ "description": "An API to enable creating and using machine learning models.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "ml:v1",
+ "documentationLink": "https://cloud.google.com/ml/",
+ "revision": "20170304",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
+ "GoogleCloudMlV1__PredictRequest": {
+ "description": "Request for predictions to be issued against a trained model.\n\nThe body of the request is a single JSON object with a single top-level\nfield:\n\n\u003cdl\u003e\n \u003cdt\u003einstances\u003c/dt\u003e\n \u003cdd\u003eA JSON array containing values representing the instances to use for\n prediction.\u003c/dd\u003e\n\u003c/dl\u003e\n\nThe structure of each element of the instances list is determined by your\nmodel's input definition. Instances can include named inputs or can contain\nonly unlabeled values.\n\nNot all data includes named inputs. Some instances will be simple\nJSON values (boolean, number, or string). However, instances are often lists\nof simple values, or complex nested lists. Here are some examples of request\nbodies:\n\nCSV data with each row encoded as a string value:\n\u003cpre\u003e\n{\"instances\": [\"1.0,true,\\\\\"x\\\\\"\", \"-2.0,false,\\\\\"y\\\\\"\"]}\n\u003c/pre\u003e\nPlain text:\n\u003cpre\u003e\n{\"instances\": [\"the quick brown fox\", \"la bruja le dio\"]}\n\u003c/pre\u003e\nSentences encoded as lists of words (vectors of strings):\n\u003cpre\u003e\n{\n \"instances\": [\n [\"the\",\"quick\",\"brown\"],\n [\"la\",\"bruja\",\"le\"],\n ...\n ]\n}\n\u003c/pre\u003e\nFloating point scalar values:\n\u003cpre\u003e\n{\"instances\": [0.0, 1.1, 2.2]}\n\u003c/pre\u003e\nVectors of integers:\n\u003cpre\u003e\n{\n \"instances\": [\n [0, 1, 2],\n [3, 4, 5],\n ...\n ]\n}\n\u003c/pre\u003e\nTensors (in this case, two-dimensional tensors):\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [0, 1, 2],\n [3, 4, 5]\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nImages can be represented different ways. In this encoding scheme the first\ntwo dimensions represent the rows and columns of the image, and the third\ncontains lists (vectors) of the R, G, and B values for each pixel.\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nJSON strings must be encoded as UTF-8. To send binary data, you must\nbase64-encode the data and mark it as binary. To mark a JSON string\nas binary, replace it with a JSON object with a single attribute named `b64`:\n\u003cpre\u003e{\"b64\": \"...\"} \u003c/pre\u003e\nFor example:\n\nTwo Serialized tf.Examples (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"X5ad6u\"}, {\"b64\": \"IA9j4nx\"}]}\n\u003c/pre\u003e\nTwo JPEG image byte strings (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"ASa8asdf\"}, {\"b64\": \"JLK7ljk3\"}]}\n\u003c/pre\u003e\nIf your data includes named references, format each instance as a JSON object\nwith the named references as the keys:\n\nJSON input data to be preprocessed:\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"a\": 1.0,\n \"b\": true,\n \"c\": \"x\"\n },\n {\n \"a\": -2.0,\n \"b\": false,\n \"c\": \"y\"\n }\n ]\n}\n\u003c/pre\u003e\nSome models have an underlying TensorFlow graph that accepts multiple input\ntensors. In this case, you should use the names of JSON name/value pairs to\nidentify the input tensors, as shown in the following exmaples:\n\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(base64-encoded string):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": {\"b64\": \"ASa8asdf\"}\n },\n {\n \"tag\": \"car\",\n \"image\": {\"b64\": \"JLK7ljk3\"}\n }\n ]\n}\n\u003c/pre\u003e\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(3-dimensional array of 8-bit ints):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ]\n },\n {\n \"tag\": \"car\",\n \"image\": [\n [\n [255, 0, 102],\n [255, 0, 97],\n ...\n ],\n [\n [254, 1, 101],\n [254, 2, 93],\n ...\n ],\n ...\n ]\n },\n ...\n ]\n}\n\u003c/pre\u003e\nIf the call is successful, the response body will contain one prediction\nentry per instance in the request body. If prediction fails for any\ninstance, the response body will contain no predictions and will contian\na single error entry instead.",
+ "type": "object",
+ "properties": {
+ "httpBody": {
+ "description": "\nRequired. The prediction request body.",
+ "$ref": "GoogleApi__HttpBody"
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictRequest"
+ },
+ "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": {
+ "description": "An observed value of a metric.",
+ "type": "object",
+ "properties": {
+ "trainingStep": {
+ "description": "The global training step for this metric.",
+ "format": "int64",
+ "type": "string"
+ },
+ "objectiveValue": {
+ "description": "The objective value at this training step.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ },
+ "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/reference/rest/v1/projects.models.versions/list).",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Optional. The description specified for the version when it was created.",
+ "type": "string"
+ },
+ "deploymentUri": {
+ "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model deployment](/ml/docs/concepts/deployment-overview) for\nmore informaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml/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.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Output only. The time the version was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "manualScaling": {
+ "description": "Optional. Manually select the number of nodes to use for serving the\nmodel. If unset (i.e., by default), the number of nodes used to serve\nthe model automatically scales with traffic. However, care should be\ntaken to ramp up traffic according to the model's ability to scale. If\nyour model needs to handle bursts of traffic beyond it's ability to\nscale, it is recommended you set this field appropriately.",
+ "$ref": "GoogleCloudMlV1__ManualScaling"
+ },
+ "name": {
+ "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
+ "type": "string"
+ },
+ "lastUseTime": {
+ "description": "Output only. The time the version was last used for prediction.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__Version"
+ },
+ "GoogleCloudMlV1__ParameterSpec": {
+ "description": "Represents a single hyperparameter to optimize.",
+ "type": "object",
+ "properties": {
+ "discreteValues": {
+ "description": "Required if type is `DISCRETE`.\nA list of feasible points.\nThe list should be in strictly increasing order. For instance, this\nparameter might have possible settings of 1.5, 2.5, and 4.0. This list\nshould not contain more than 1,000 values.",
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "scaleType": {
+ "description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).",
+ "type": "string",
+ "enumDescriptions": [
+ "By default, no scaling is applied.",
+ "Scales the feasible space to (0, 1) linearly.",
+ "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": {
+ "description": "Required if typeis `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is `INTEGER`.",
+ "format": "double",
+ "type": "number"
+ },
+ "type": {
+ "enumDescriptions": [
+ "You must specify a valid type. Using this unspecified type will result in\nan error.",
+ "Type for real-valued parameters.",
+ "Type for integral parameters.",
+ "The parameter is categorical, with a value chosen from the categories\nfield.",
+ "The parameter is real valued, with a fixed set of feasible points. If\n`type==DISCRETE`, feasible_points must be provided, and\n{`min_value`, `max_value`} will be ignored."
+ ],
+ "enum": [
+ "PARAMETER_TYPE_UNSPECIFIED",
+ "DOUBLE",
+ "INTEGER",
+ "CATEGORICAL",
+ "DISCRETE"
+ ],
+ "description": "Required. The type of the parameter.",
+ "type": "string"
+ },
+ "parameterName": {
+ "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
+ "type": "string"
+ },
+ "categoricalValues": {
+ "description": "Required if type is `CATEGORICAL`. The list of possible categories.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "minValue": {
+ "description": "Required if type is `DOUBLE` or `INTEGER`. This field\nshould be unset if type is `CATEGORICAL`. This value should be integers if\ntype is INTEGER.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "GoogleCloudMlV1__ParameterSpec"
+ },
+ "GoogleCloudMlV1__PredictionInput": {
+ "description": "Represents input parameters for a prediction job.",
+ "type": "object",
+ "properties": {
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the prediction job in.",
+ "type": "string"
+ },
+ "versionName": {
+ "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`",
+ "type": "string"
+ },
+ "modelName": {
+ "description": "Use this field if you want to use the default version for the specified\nmodel. The string must use the following format:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003e[YOUR_MODEL]\u003c/var\u003e\"`",
+ "type": "string"
+ },
+ "outputPath": {
+ "description": "Required. The output Google Cloud Storage location.",
+ "type": "string"
+ },
+ "maxWorkerCount": {
+ "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.",
+ "format": "int64",
+ "type": "string"
+ },
+ "uri": {
+ "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.",
+ "type": "string"
+ },
+ "dataFormat": {
+ "enumDescriptions": [
+ "Unspecified format.",
+ "The source file is a text file with instances separated by the\nnew-line character.",
+ "The source file is a TFRecord file.",
+ "The source file is a GZIP-compressed TFRecord file."
+ ],
+ "enum": [
+ "DATA_FORMAT_UNSPECIFIED",
+ "TEXT",
+ "TF_RECORD",
+ "TF_RECORD_GZIP"
+ ],
+ "description": "Required. The format of the input data files.",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
+ "type": "string"
+ },
+ "inputPaths": {
+ "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GoogleCloudMlV1__PredictionInput"
+ },
+ "GoogleCloudMlV1beta1__OperationMetadata": {
+ "description": "Represents the metadata of the long-running operation.",
+ "type": "object",
+ "properties": {
+ "createTime": {
+ "description": "The time the operation was submitted.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "modelName": {
+ "description": "Contains the name of the model associated with the operation.",
+ "type": "string"
+ },
+ "version": {
+ "description": "Contains the version associated with the operation.",
+ "$ref": "GoogleCloudMlV1beta1__Version"
+ },
+ "endTime": {
+ "description": "The time operation processing completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "enumDescriptions": [
+ "Unspecified operation type.",
+ "An operation to create a new version.",
+ "An operation to delete an existing version.",
+ "An operation to delete an existing model."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE_VERSION",
+ "DELETE_VERSION",
+ "DELETE_MODEL"
+ ],
+ "description": "The operation type.",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time operation processing started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "isCancellationRequested": {
+ "description": "Indicates whether a request to cancel this operation has been made.",
+ "type": "boolean"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__OperationMetadata"
+ },
+ "GoogleCloudMlV1__OperationMetadata": {
+ "id": "GoogleCloudMlV1__OperationMetadata",
+ "description": "Represents the metadata of the long-running operation.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "$ref": "GoogleCloudMlV1__Version",
+ "description": "Contains the version associated with the operation."
+ },
+ "endTime": {
+ "description": "The time operation processing completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "operationType": {
+ "description": "The operation type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified operation type.",
+ "An operation to create a new version.",
+ "An operation to delete an existing version.",
+ "An operation to delete an existing model."
+ ],
+ "enum": [
+ "OPERATION_TYPE_UNSPECIFIED",
+ "CREATE_VERSION",
+ "DELETE_VERSION",
+ "DELETE_MODEL"
+ ]
+ },
+ "startTime": {
+ "description": "The time operation processing started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "isCancellationRequested": {
+ "description": "Indicates whether a request to cancel this operation has been made.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "The time the operation was submitted.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "modelName": {
+ "description": "Contains the name of the model associated with the operation.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1__HyperparameterSpec": {
+ "id": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Represents a set of hyperparameters to optimize.",
+ "type": "object",
+ "properties": {
+ "params": {
+ "description": "Required. The set of parameters to tune.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__ParameterSpec"
+ }
+ },
+ "maxTrials": {
+ "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxParallelTrials": {
+ "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "goal": {
+ "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Goal Type will default to maximize.",
+ "Maximize the goal metric.",
+ "Minimize the goal metric."
+ ],
+ "enum": [
+ "GOAL_TYPE_UNSPECIFIED",
+ "MAXIMIZE",
+ "MINIMIZE"
+ ]
+ },
+ "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"
+ }
+ }
+ },
+ "GoogleCloudMlV1__ListJobsResponse": {
+ "description": "Response message for the ListJobs method.",
+ "type": "object",
+ "properties": {
+ "jobs": {
+ "description": "The list of jobs.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Job"
+ }
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__ListJobsResponse"
+ },
+ "GoogleCloudMlV1__SetDefaultVersionRequest": {
+ "id": "GoogleCloudMlV1__SetDefaultVersionRequest",
+ "description": "Request message for the SetDefaultVersion request.",
+ "type": "object",
+ "properties": {}
+ },
+ "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": {
+ "$ref": "GoogleRpc__Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "GoogleLongrunning__Operation"
+ },
+ "GoogleCloudMlV1__Model": {
+ "id": "GoogleCloudMlV1__Model",
+ "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. The description specified for the model when it was created.",
+ "type": "string"
+ },
+ "onlinePredictionLogging": {
+ "description": "Optional. If true, enables StackDriver Logging for online prediction.\nDefault is false.",
+ "type": "boolean"
+ },
+ "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/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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "GoogleProtobuf__Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleProtobuf__Empty"
+ },
+ "GoogleCloudMlV1__CancelJobRequest": {
+ "description": "Request message for the CancelJob method.",
+ "type": "object",
+ "properties": {},
+ "id": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "GoogleCloudMlV1__ListVersionsResponse": {
+ "description": "Response message for the ListVersions method.",
+ "type": "object",
+ "properties": {
+ "versions": {
+ "description": "The list of versions.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Version"
+ }
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "GoogleCloudMlV1beta1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to nodes * number of hours since\ndeployment.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__ManualScaling"
+ },
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "id": "GoogleRpc__Status"
+ },
+ "GoogleCloudMlV1__TrainingInput": {
+ "id": "GoogleCloudMlV1__TrainingInput",
+ "description": "Represents input parameters for a training job.",
+ "type": "object",
+ "properties": {
+ "workerCount": {
+ "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "masterType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"ml/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\"\u003ecoplex_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"
+ },
+ "pythonModule": {
+ "description": "Required. The Python module name to run after installing the packages.",
+ "type": "string"
+ },
+ "workerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.",
+ "type": "string"
+ },
+ "args": {
+ "description": "Optional. Command line arguments to pass to the program.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the training job in.",
+ "type": "string"
+ },
+ "parameterServerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
+ "type": "string"
+ },
+ "scaleTier": {
+ "enumDescriptions": [
+ "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.",
+ "Many workers and a few parameter servers.",
+ "A large number of workers with many parameter servers.",
+ "A single worker instance [with a GPU](ml/docs/how-tos/using-gpus).",
+ "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type."
+ ],
+ "enum": [
+ "BASIC",
+ "STANDARD_1",
+ "PREMIUM_1",
+ "BASIC_GPU",
+ "CUSTOM"
+ ],
+ "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
+ "type": "string"
+ },
+ "jobDir": {
+ "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
+ "type": "string"
+ },
+ "hyperparameters": {
+ "$ref": "GoogleCloudMlV1__HyperparameterSpec",
+ "description": "Optional. The set of Hyperparameters to tune."
+ },
+ "parameterServerCount": {
+ "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "packageUris": {
+ "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "GoogleCloudMlV1__ListModelsResponse": {
+ "id": "GoogleCloudMlV1__ListModelsResponse",
+ "description": "Response message for the ListModels method.",
+ "type": "object",
+ "properties": {
+ "models": {
+ "description": "The list of models.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__Model"
+ }
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1__Job": {
+ "id": "GoogleCloudMlV1__Job",
+ "description": "Represents a training or prediction job.",
+ "type": "object",
+ "properties": {
+ "trainingOutput": {
+ "description": "The current training job result.",
+ "$ref": "GoogleCloudMlV1__TrainingOutput"
+ },
+ "trainingInput": {
+ "$ref": "GoogleCloudMlV1__TrainingInput",
+ "description": "Input parameters to create a training job."
+ },
+ "createTime": {
+ "description": "Output only. When the job was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "predictionInput": {
+ "$ref": "GoogleCloudMlV1__PredictionInput",
+ "description": "Input parameters to create a prediction job."
+ },
+ "state": {
+ "description": "Output only. The detailed state of a job.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job state is unspecified.",
+ "The job has been just created and processing has not yet begun.",
+ "The service is preparing to run the job.",
+ "The job is in progress.",
+ "The job completed successfully.",
+ "The job failed.\n`error_message` should contain the details of the failure.",
+ "The job is being cancelled.\n`error_message` should describe the reason for the cancellation.",
+ "The job has been cancelled.\n`error_message` should describe the reason for the cancellation."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "QUEUED",
+ "PREPARING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLING",
+ "CANCELLED"
+ ]
+ },
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Output only. The details of a failure or a cancellation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Output only. When the job processing was completed.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Output only. When the job processing was started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "predictionOutput": {
+ "description": "The current prediction job result.",
+ "$ref": "GoogleCloudMlV1__PredictionOutput"
+ }
+ }
+ },
+ "GoogleApi__HttpBody": {
+ "id": "GoogleApi__HttpBody",
+ "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "HTTP body binary data.",
+ "format": "byte",
+ "type": "string"
+ },
+ "contentType": {
+ "description": "The HTTP Content-Type string representing the content type of the body.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1__GetConfigResponse": {
+ "id": "GoogleCloudMlV1__GetConfigResponse",
+ "description": "Returns service account information associated with a project.",
+ "type": "object",
+ "properties": {
+ "serviceAccountProject": {
+ "description": "The project number for `service_account`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "description": "The service account Cloud ML uses to access resources in the project.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1beta1__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/reference/rest/v1beta1/projects.models.versions/list).",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
+ "type": "string"
+ },
+ "lastUseTime": {
+ "description": "Output only. The time the version was last used for prediction.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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": {
+ "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model deployment](/ml/docs/concepts/deployment-overview) for\nmore informaiton.\n\nWhen passing Version to\n[projects.models.versions.create](/ml/reference/rest/v1beta1/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.",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "Output only. The time the version was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "manualScaling": {
+ "$ref": "GoogleCloudMlV1beta1__ManualScaling",
+ "description": "Optional. Manually select the number of nodes to use for serving the\nmodel. If unset (i.e., by default), the number of nodes used to serve\nthe model automatically scales with traffic. However, care should be\ntaken to ramp up traffic according to the model's ability to scale. If\nyour model needs to handle bursts of traffic beyond it's ability to\nscale, it is recommended you set this field appropriately."
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__Version"
+ },
+ "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",
+ "properties": {
+ "allMetrics": {
+ "description": "All recorded object metrics for this trial.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric"
+ }
+ },
+ "finalMetric": {
+ "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric",
+ "description": "The final objective metric seen for this trial."
+ },
+ "hyperparameters": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The hyperparameters given to this trial.",
+ "type": "object"
+ },
+ "trialId": {
+ "description": "The trial id for these results.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1__PredictionOutput": {
+ "id": "GoogleCloudMlV1__PredictionOutput",
+ "description": "Represents results of a prediction job.",
+ "type": "object",
+ "properties": {
+ "errorCount": {
+ "description": "The number of data instances which resulted in errors.",
+ "format": "int64",
+ "type": "string"
+ },
+ "outputPath": {
+ "description": "The output Google Cloud Storage location provided at the job creation time.",
+ "type": "string"
+ },
+ "nodeHours": {
+ "description": "Node hours used by the batch prediction job.",
+ "format": "double",
+ "type": "number"
+ },
+ "predictionCount": {
+ "description": "The number of generated predictions.",
+ "format": "int64",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleLongrunning__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": "GoogleLongrunning__Operation"
+ }
+ }
+ },
+ "id": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "GoogleCloudMlV1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to nodes * number of hours since\ndeployment.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__ManualScaling"
+ },
+ "GoogleCloudMlV1__TrainingOutput": {
+ "id": "GoogleCloudMlV1__TrainingOutput",
+ "description": "Represents results of a training job. Output only.",
+ "type": "object",
+ "properties": {
+ "trials": {
+ "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1__HyperparameterOutput"
+ }
+ },
+ "completedTrialCount": {
+ "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
+ "format": "int64",
+ "type": "string"
+ },
+ "isHyperparameterTuningJob": {
+ "description": "Whether this job is a hyperparameter tuning job.",
+ "type": "boolean"
+ },
+ "consumedMLUnits": {
+ "description": "The amount of ML units consumed by the job.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ }
+ },
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest",
+ "canonicalName": "Cloud Machine Learning Engine",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/cloud-platform": {
+ "description": "View and manage your data across Google Cloud Platform services"
+ }
+ }
+ }
+ },
+ "rootUrl": "https://ml.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "ml",
+ "batchPath": "batch",
+ "title": "Google Cloud Machine Learning Engine",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "methods": {
+ "getConfig": {
+ "path": "v1/{+name}:getConfig",
+ "id": "ml.projects.getConfig",
+ "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__GetConfigResponse"
+ },
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:getConfig"
+ },
+ "predict": {
+ "path": "v1/{+name}:predict",
+ "id": "ml.projects.predict",
+ "description": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
+ "request": {
+ "$ref": "GoogleCloudMlV1__PredictRequest"
+ },
+ "response": {
+ "$ref": "GoogleApi__HttpBody"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}:predict"
+ }
+ },
+ "resources": {
+ "jobs": {
+ "methods": {
+ "list": {
+ "id": "ml.projects.jobs.list",
+ "path": "v1/{+parent}/jobs",
+ "description": "Lists the jobs in the project.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project for which to list jobs.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Optional. Specifies the subset of jobs to retrieve.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "ml.projects.jobs.get",
+ "description": "Describes a job.",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to get the description of.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}"
+ },
+ "create": {
+ "id": "ml.projects.jobs.create",
+ "path": "v1/{+parent}/jobs",
+ "description": "Creates a training or a batch prediction job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__Job"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs"
+ },
+ "cancel": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the job to cancel.\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.jobs.cancel",
+ "description": "Cancels a running job.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ },
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "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`.",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ },
+ "list": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "response": {
+ "$ref": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET"
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "ml.projects.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}"
+ },
+ "cancel": {
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "ml.projects.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ }
+ }
+ },
+ "models": {
+ "methods": {
+ "delete": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1/{+name}",
+ "id": "ml.projects.models.delete",
+ "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml/reference/rest/v1/projects.models.versions/delete)."
+ },
+ "list": {
+ "parameters": {
+ "pageToken": {
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "Required. The name of the project whose models are to be listed.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ]
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ "id": "ml.projects.models.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models",
+ "path": "v1/{+parent}/models",
+ "id": "ml.projects.models.create",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Model"
+ },
+ "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml/reference/rest/v1/projects.models.versions/create)."
+ }
+ },
+ "resources": {
+ "versions": {
+ "methods": {
+ "create": {
+ "path": "v1/{+parent}/versions",
+ "id": "ml.projects.models.versions.create",
+ "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml/reference/rest/v1/projects.models.versions/setDefault).",
+ "request": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions"
+ },
+ "setDefault": {
+ "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
+ "request": {
+ "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ },
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "path": "v1/{+name}:setDefault",
+ "id": "ml.projects.models.versions.setDefault"
+ },
+ "delete": {
+ "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.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "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/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}"
+ },
+ "list": {
+ "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": {
+ "location": "query",
+ "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "parent": {
+ "description": "Required. The name of the model for which to list the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ "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):",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ]
+ },
+ "get": {
+ "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/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",
+ "response": {
+ "$ref": "GoogleCloudMlV1__Version"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
+ "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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://ml.googleapis.com/"
+}
diff --git a/ml/v1/ml-gen.go b/ml/v1/ml-gen.go
new file mode 100644
index 0000000..fb3b773
--- /dev/null
+++ b/ml/v1/ml-gen.go
@@ -0,0 +1,5017 @@
+// Package ml provides access to the Google Cloud Machine Learning Engine.
+//
+// See https://cloud.google.com/ml/
+//
+// Usage example:
+//
+// import "google.golang.org/api/ml/v1"
+// ...
+// mlService, err := ml.New(oauthHttpClient)
+package ml // import "google.golang.org/api/ml/v1"
+
+import (
+ "bytes"
+ "encoding/json"
+ "errors"
+ "fmt"
+ context "golang.org/x/net/context"
+ ctxhttp "golang.org/x/net/context/ctxhttp"
+ gensupport "google.golang.org/api/gensupport"
+ googleapi "google.golang.org/api/googleapi"
+ "io"
+ "net/http"
+ "net/url"
+ "strconv"
+ "strings"
+)
+
+// Always reference these packages, just in case the auto-generated code
+// below doesn't.
+var _ = bytes.NewBuffer
+var _ = strconv.Itoa
+var _ = fmt.Sprintf
+var _ = json.NewDecoder
+var _ = io.Copy
+var _ = url.Parse
+var _ = gensupport.MarshalJSON
+var _ = googleapi.Version
+var _ = errors.New
+var _ = strings.Replace
+var _ = context.Canceled
+var _ = ctxhttp.Do
+
+const apiId = "ml:v1"
+const apiName = "ml"
+const apiVersion = "v1"
+const basePath = "https://ml.googleapis.com/"
+
+// OAuth2 scopes used by this API.
+const (
+ // View and manage your data across Google Cloud Platform services
+ CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
+)
+
+func New(client *http.Client) (*Service, error) {
+ if client == nil {
+ return nil, errors.New("client is nil")
+ }
+ s := &Service{client: client, BasePath: basePath}
+ s.Projects = NewProjectsService(s)
+ return s, nil
+}
+
+type Service struct {
+ client *http.Client
+ BasePath string // API endpoint base URL
+ UserAgent string // optional additional User-Agent fragment
+ GoogleClientHeaderElement string // client header fragment, for Google use only
+
+ Projects *ProjectsService
+}
+
+func (s *Service) userAgent() string {
+ if s.UserAgent == "" {
+ return googleapi.UserAgent
+ }
+ return googleapi.UserAgent + " " + s.UserAgent
+}
+
+func (s *Service) clientHeader() string {
+ return gensupport.GoogleClientHeader("20170210", s.GoogleClientHeaderElement)
+}
+
+func NewProjectsService(s *Service) *ProjectsService {
+ rs := &ProjectsService{s: s}
+ rs.Jobs = NewProjectsJobsService(s)
+ rs.Models = NewProjectsModelsService(s)
+ rs.Operations = NewProjectsOperationsService(s)
+ return rs
+}
+
+type ProjectsService struct {
+ s *Service
+
+ Jobs *ProjectsJobsService
+
+ Models *ProjectsModelsService
+
+ Operations *ProjectsOperationsService
+}
+
+func NewProjectsJobsService(s *Service) *ProjectsJobsService {
+ rs := &ProjectsJobsService{s: s}
+ return rs
+}
+
+type ProjectsJobsService struct {
+ s *Service
+}
+
+func NewProjectsModelsService(s *Service) *ProjectsModelsService {
+ rs := &ProjectsModelsService{s: s}
+ rs.Versions = NewProjectsModelsVersionsService(s)
+ return rs
+}
+
+type ProjectsModelsService struct {
+ s *Service
+
+ Versions *ProjectsModelsVersionsService
+}
+
+func NewProjectsModelsVersionsService(s *Service) *ProjectsModelsVersionsService {
+ rs := &ProjectsModelsVersionsService{s: s}
+ return rs
+}
+
+type ProjectsModelsVersionsService struct {
+ s *Service
+}
+
+func NewProjectsOperationsService(s *Service) *ProjectsOperationsService {
+ rs := &ProjectsOperationsService{s: s}
+ return rs
+}
+
+type ProjectsOperationsService struct {
+ s *Service
+}
+
+// GoogleApi__HttpBody: Message that represents an arbitrary HTTP body.
+// It should only be used for
+// payload formats that can't be represented as JSON, such as raw binary
+// or
+// an HTML page.
+//
+//
+// This message can be used both in streaming and non-streaming API
+// methods in
+// the request as well as the response.
+//
+// It can be used as a top-level request field, which is convenient if
+// one
+// wants to extract parameters from either the URL or HTTP template into
+// the
+// request fields and also want access to the raw HTTP body.
+//
+// Example:
+//
+// message GetResourceRequest {
+// // A unique request id.
+// string request_id = 1;
+//
+// // The raw HTTP body is bound to this field.
+// google.api.HttpBody http_body = 2;
+// }
+//
+// service ResourceService {
+// rpc GetResource(GetResourceRequest) returns
+// (google.api.HttpBody);
+// rpc UpdateResource(google.api.HttpBody) returns
+// (google.protobuf.Empty);
+// }
+//
+// Example with streaming methods:
+//
+// service CaldavService {
+// rpc GetCalendar(stream google.api.HttpBody)
+// returns (stream google.api.HttpBody);
+// rpc UpdateCalendar(stream google.api.HttpBody)
+// returns (stream google.api.HttpBody);
+// }
+//
+// Use of this type only changes how the request and response bodies
+// are
+// handled, all other features will continue to work unchanged.
+type GoogleApi__HttpBody struct {
+ // ContentType: The HTTP Content-Type string representing the content
+ // type of the body.
+ ContentType string `json:"contentType,omitempty"`
+
+ // Data: HTTP body binary data.
+ Data string `json:"data,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ContentType") 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. "ContentType") 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 *GoogleApi__HttpBody) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleApi__HttpBody
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1HyperparameterOutputHyperparameterMetric: An observed
+// value of a metric.
+type GoogleCloudMlV1HyperparameterOutputHyperparameterMetric struct {
+ // ObjectiveValue: The objective value at this training step.
+ ObjectiveValue float64 `json:"objectiveValue,omitempty"`
+
+ // TrainingStep: The global training step for this metric.
+ TrainingStep int64 `json:"trainingStep,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "ObjectiveValue") 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. "ObjectiveValue") 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 *GoogleCloudMlV1HyperparameterOutputHyperparameterMetric) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1HyperparameterOutputHyperparameterMetric
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *GoogleCloudMlV1HyperparameterOutputHyperparameterMetric) UnmarshalJSON(data []byte) error {
+ type noMethod GoogleCloudMlV1HyperparameterOutputHyperparameterMetric
+ var s1 struct {
+ ObjectiveValue gensupport.JSONFloat64 `json:"objectiveValue"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.ObjectiveValue = float64(s1.ObjectiveValue)
+ return nil
+}
+
+// GoogleCloudMlV1__CancelJobRequest: Request message for the CancelJob
+// method.
+type GoogleCloudMlV1__CancelJobRequest struct {
+}
+
+// GoogleCloudMlV1__GetConfigResponse: Returns service account
+// information associated with a project.
+type GoogleCloudMlV1__GetConfigResponse struct {
+ // ServiceAccount: The service account Cloud ML uses to access resources
+ // in the project.
+ ServiceAccount string `json:"serviceAccount,omitempty"`
+
+ // ServiceAccountProject: The project number for `service_account`.
+ ServiceAccountProject int64 `json:"serviceAccountProject,omitempty,string"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ServiceAccount") 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. "ServiceAccount") 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 *GoogleCloudMlV1__GetConfigResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__GetConfigResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__HyperparameterOutput: Represents the result of a
+// single hyperparameter tuning trial from a
+// training job. The TrainingOutput object that is returned on
+// successful
+// completion of a training job with hyperparameter tuning includes a
+// list
+// of HyperparameterOutput objects, one for each successful trial.
+type GoogleCloudMlV1__HyperparameterOutput struct {
+ // AllMetrics: All recorded object metrics for this trial.
+ AllMetrics []*GoogleCloudMlV1HyperparameterOutputHyperparameterMetric `json:"allMetrics,omitempty"`
+
+ // FinalMetric: The final objective metric seen for this trial.
+ FinalMetric *GoogleCloudMlV1HyperparameterOutputHyperparameterMetric `json:"finalMetric,omitempty"`
+
+ // Hyperparameters: The hyperparameters given to this trial.
+ Hyperparameters map[string]string `json:"hyperparameters,omitempty"`
+
+ // TrialId: The trial id for these results.
+ TrialId string `json:"trialId,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AllMetrics") 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. "AllMetrics") 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 *GoogleCloudMlV1__HyperparameterOutput) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__HyperparameterOutput
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__HyperparameterSpec: Represents a set of
+// hyperparameters to optimize.
+type GoogleCloudMlV1__HyperparameterSpec struct {
+ // Goal: Required. The type of goal to use for tuning. Available types
+ // are
+ // `MAXIMIZE` and `MINIMIZE`.
+ //
+ // Defaults to `MAXIMIZE`.
+ //
+ // Possible values:
+ // "GOAL_TYPE_UNSPECIFIED" - Goal Type will default to maximize.
+ // "MAXIMIZE" - Maximize the goal metric.
+ // "MINIMIZE" - Minimize the goal metric.
+ Goal string `json:"goal,omitempty"`
+
+ // HyperparameterMetricTag: Optional. The Tensorflow summary tag name to
+ // use for optimizing trials. For
+ // current versions of Tensorflow, this tag name should exactly match
+ // what is
+ // shown in Tensorboard, including all scopes. For versions of
+ // Tensorflow
+ // prior to 0.12, this should be only the tag passed to tf.Summary.
+ // By default, "training/hptuning/metric" will be used.
+ HyperparameterMetricTag string `json:"hyperparameterMetricTag,omitempty"`
+
+ // MaxParallelTrials: Optional. The number of training trials to run
+ // concurrently.
+ // You can reduce the time it takes to perform hyperparameter tuning by
+ // adding
+ // trials in parallel. However, each trail only benefits from the
+ // information
+ // gained in completed trials. That means that a trial does not get
+ // access to
+ // the results of trials running at the same time, which could reduce
+ // the
+ // quality of the overall optimization.
+ //
+ // Each trial will use the same scale tier and machine types.
+ //
+ // Defaults to one.
+ MaxParallelTrials int64 `json:"maxParallelTrials,omitempty"`
+
+ // MaxTrials: Optional. How many training trials should be attempted to
+ // optimize
+ // the specified hyperparameters.
+ //
+ // Defaults to one.
+ MaxTrials int64 `json:"maxTrials,omitempty"`
+
+ // Params: Required. The set of parameters to tune.
+ Params []*GoogleCloudMlV1__ParameterSpec `json:"params,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Goal") 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. "Goal") 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 *GoogleCloudMlV1__HyperparameterSpec) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__HyperparameterSpec
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__Job: Represents a training or prediction job.
+type GoogleCloudMlV1__Job struct {
+ // CreateTime: Output only. When the job was created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // EndTime: Output only. When the job processing was completed.
+ EndTime string `json:"endTime,omitempty"`
+
+ // ErrorMessage: Output only. The details of a failure or a
+ // cancellation.
+ ErrorMessage string `json:"errorMessage,omitempty"`
+
+ // JobId: Required. The user-specified id of the job.
+ JobId string `json:"jobId,omitempty"`
+
+ // PredictionInput: Input parameters to create a prediction job.
+ PredictionInput *GoogleCloudMlV1__PredictionInput `json:"predictionInput,omitempty"`
+
+ // PredictionOutput: The current prediction job result.
+ PredictionOutput *GoogleCloudMlV1__PredictionOutput `json:"predictionOutput,omitempty"`
+
+ // StartTime: Output only. When the job processing was started.
+ StartTime string `json:"startTime,omitempty"`
+
+ // State: Output only. The detailed state of a job.
+ //
+ // Possible values:
+ // "STATE_UNSPECIFIED" - The job state is unspecified.
+ // "QUEUED" - The job has been just created and processing has not yet
+ // begun.
+ // "PREPARING" - The service is preparing to run the job.
+ // "RUNNING" - The job is in progress.
+ // "SUCCEEDED" - The job completed successfully.
+ // "FAILED" - The job failed.
+ // `error_message` should contain the details of the failure.
+ // "CANCELLING" - The job is being cancelled.
+ // `error_message` should describe the reason for the cancellation.
+ // "CANCELLED" - The job has been cancelled.
+ // `error_message` should describe the reason for the cancellation.
+ State string `json:"state,omitempty"`
+
+ // TrainingInput: Input parameters to create a training job.
+ TrainingInput *GoogleCloudMlV1__TrainingInput `json:"trainingInput,omitempty"`
+
+ // TrainingOutput: The current training job result.
+ TrainingOutput *GoogleCloudMlV1__TrainingOutput `json:"trainingOutput,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleCloudMlV1__Job) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__Job
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__ListJobsResponse: Response message for the ListJobs
+// method.
+type GoogleCloudMlV1__ListJobsResponse struct {
+ // Jobs: The list of jobs.
+ Jobs []*GoogleCloudMlV1__Job `json:"jobs,omitempty"`
+
+ // NextPageToken: Optional. Pass this token as the `page_token` field of
+ // the request for a
+ // subsequent call.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Jobs") 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. "Jobs") 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 *GoogleCloudMlV1__ListJobsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__ListJobsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__ListModelsResponse: Response message for the
+// ListModels method.
+type GoogleCloudMlV1__ListModelsResponse struct {
+ // Models: The list of models.
+ Models []*GoogleCloudMlV1__Model `json:"models,omitempty"`
+
+ // NextPageToken: Optional. Pass this token as the `page_token` field of
+ // the request for a
+ // subsequent call.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Models") 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. "Models") 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 *GoogleCloudMlV1__ListModelsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__ListModelsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__ListVersionsResponse: Response message for the
+// ListVersions method.
+type GoogleCloudMlV1__ListVersionsResponse struct {
+ // NextPageToken: Optional. Pass this token as the `page_token` field of
+ // the request for a
+ // subsequent call.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Versions: The list of versions.
+ Versions []*GoogleCloudMlV1__Version `json:"versions,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 *GoogleCloudMlV1__ListVersionsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__ListVersionsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__ManualScaling: Options for manually scaling a model.
+type GoogleCloudMlV1__ManualScaling struct {
+ // Nodes: The number of nodes to allocate for this model. These nodes
+ // are always up,
+ // starting from the time the model is deployed, so the cost of
+ // operating
+ // this model will be proportional to nodes * number of hours
+ // since
+ // deployment.
+ Nodes int64 `json:"nodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Nodes") 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. "Nodes") 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 *GoogleCloudMlV1__ManualScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__ManualScaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__Model: Represents a machine learning solution.
+//
+// A model can have multiple versions, each of which is a deployed,
+// trained
+// model ready to receive prediction requests. The model itself is just
+// a
+// container.
+type GoogleCloudMlV1__Model struct {
+ // DefaultVersion: Output only. The default version of the model. This
+ // version will be used to
+ // handle prediction requests that do not specify a version.
+ //
+ // You can change the default version by
+ // calling
+ // [projects.methods.versions.setDefault](/ml/reference/rest/v1/p
+ // rojects.models.versions/setDefault).
+ DefaultVersion *GoogleCloudMlV1__Version `json:"defaultVersion,omitempty"`
+
+ // Description: Optional. The description specified for the model when
+ // it was created.
+ Description string `json:"description,omitempty"`
+
+ // Name: Required. The name specified for the model when it was
+ // created.
+ //
+ // The model name must be unique within the project it is created in.
+ Name string `json:"name,omitempty"`
+
+ // OnlinePredictionLogging: Optional. If true, enables StackDriver
+ // Logging for online prediction.
+ // Default is false.
+ OnlinePredictionLogging bool `json:"onlinePredictionLogging,omitempty"`
+
+ // Regions: Optional. The list of regions where the model is going to be
+ // deployed.
+ // Currently only one region per model is supported.
+ // Defaults to 'us-central1' if nothing is set.
+ Regions []string `json:"regions,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "DefaultVersion") 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. "DefaultVersion") 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 *GoogleCloudMlV1__Model) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__Model
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__OperationMetadata: Represents the metadata of the
+// long-running operation.
+type GoogleCloudMlV1__OperationMetadata struct {
+ // CreateTime: The time the operation was submitted.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // EndTime: The time operation processing completed.
+ EndTime string `json:"endTime,omitempty"`
+
+ // IsCancellationRequested: Indicates whether a request to cancel this
+ // operation has been made.
+ IsCancellationRequested bool `json:"isCancellationRequested,omitempty"`
+
+ // ModelName: Contains the name of the model associated with the
+ // operation.
+ ModelName string `json:"modelName,omitempty"`
+
+ // OperationType: The operation type.
+ //
+ // Possible values:
+ // "OPERATION_TYPE_UNSPECIFIED" - Unspecified operation type.
+ // "CREATE_VERSION" - An operation to create a new version.
+ // "DELETE_VERSION" - An operation to delete an existing version.
+ // "DELETE_MODEL" - An operation to delete an existing model.
+ OperationType string `json:"operationType,omitempty"`
+
+ // StartTime: The time operation processing started.
+ StartTime string `json:"startTime,omitempty"`
+
+ // Version: Contains the version associated with the operation.
+ Version *GoogleCloudMlV1__Version `json:"version,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleCloudMlV1__OperationMetadata) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__OperationMetadata
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__ParameterSpec: Represents a single hyperparameter to
+// optimize.
+type GoogleCloudMlV1__ParameterSpec struct {
+ // CategoricalValues: Required if type is `CATEGORICAL`. The list of
+ // possible categories.
+ CategoricalValues []string `json:"categoricalValues,omitempty"`
+
+ // DiscreteValues: Required if type is `DISCRETE`.
+ // A list of feasible points.
+ // The list should be in strictly increasing order. For instance,
+ // this
+ // parameter might have possible settings of 1.5, 2.5, and 4.0. This
+ // list
+ // should not contain more than 1,000 values.
+ DiscreteValues []float64 `json:"discreteValues,omitempty"`
+
+ // MaxValue: Required if typeis `DOUBLE` or `INTEGER`. This field
+ // should be unset if type is `CATEGORICAL`. This value should be
+ // integers if
+ // type is `INTEGER`.
+ MaxValue float64 `json:"maxValue,omitempty"`
+
+ // MinValue: Required if type is `DOUBLE` or `INTEGER`. This
+ // field
+ // should be unset if type is `CATEGORICAL`. This value should be
+ // integers if
+ // type is INTEGER.
+ MinValue float64 `json:"minValue,omitempty"`
+
+ // ParameterName: Required. The parameter name must be unique amongst
+ // all ParameterConfigs in
+ // a HyperparameterSpec message. E.g., "learning_rate".
+ ParameterName string `json:"parameterName,omitempty"`
+
+ // ScaleType: Optional. How the parameter should be scaled to the
+ // hypercube.
+ // Leave unset for categorical parameters.
+ // Some kind of scaling is strongly recommended for real or
+ // integral
+ // parameters (e.g., `UNIT_LINEAR_SCALE`).
+ //
+ // Possible values:
+ // "NONE" - By default, no scaling is applied.
+ // "UNIT_LINEAR_SCALE" - Scales the feasible space to (0, 1) linearly.
+ // "UNIT_LOG_SCALE" - Scales the feasible space logarithmically to (0,
+ // 1). The entire feasible
+ // space must be strictly positive.
+ // "UNIT_REVERSE_LOG_SCALE" - Scales the feasible space "reverse"
+ // logarithmically to (0, 1). The result
+ // is that values close to the top of the feasible space are spread out
+ // more
+ // than points near the bottom. The entire feasible space must be
+ // strictly
+ // positive.
+ ScaleType string `json:"scaleType,omitempty"`
+
+ // Type: Required. The type of the parameter.
+ //
+ // Possible values:
+ // "PARAMETER_TYPE_UNSPECIFIED" - You must specify a valid type. Using
+ // this unspecified type will result in
+ // an error.
+ // "DOUBLE" - Type for real-valued parameters.
+ // "INTEGER" - Type for integral parameters.
+ // "CATEGORICAL" - The parameter is categorical, with a value chosen
+ // from the categories
+ // field.
+ // "DISCRETE" - The parameter is real valued, with a fixed set of
+ // feasible points. If
+ // `type==DISCRETE`, feasible_points must be provided, and
+ // {`min_value`, `max_value`} will be ignored.
+ Type string `json:"type,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CategoricalValues")
+ // 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. "CategoricalValues") 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 *GoogleCloudMlV1__ParameterSpec) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__ParameterSpec
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *GoogleCloudMlV1__ParameterSpec) UnmarshalJSON(data []byte) error {
+ type noMethod GoogleCloudMlV1__ParameterSpec
+ var s1 struct {
+ MaxValue gensupport.JSONFloat64 `json:"maxValue"`
+ MinValue gensupport.JSONFloat64 `json:"minValue"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.MaxValue = float64(s1.MaxValue)
+ s.MinValue = float64(s1.MinValue)
+ return nil
+}
+
+// GoogleCloudMlV1__PredictRequest: Request for predictions to be issued
+// against a trained model.
+//
+// The body of the request is a single JSON object with a single
+// top-level
+// field:
+//
+// <dl>
+// <dt>instances</dt>
+// <dd>A JSON array containing values representing the instances to
+// use for
+// prediction.</dd>
+// </dl>
+//
+// The structure of each element of the instances list is determined by
+// your
+// model's input definition. Instances can include named inputs or can
+// contain
+// only unlabeled values.
+//
+// Not all data includes named inputs. Some instances will be
+// simple
+// JSON values (boolean, number, or string). However, instances are
+// often lists
+// of simple values, or complex nested lists. Here are some examples of
+// request
+// bodies:
+//
+// CSV data with each row encoded as a string value:
+// <pre>
+// {"instances": ["1.0,true,\\"x\\"",
+// "-2.0,false,\\"y\\""]}
+// </pre>
+// Plain text:
+// <pre>
+// {"instances": ["the quick brown fox", "la bruja le
+// dio"]}
+// </pre>
+// Sentences encoded as lists of words (vectors of strings):
+// <pre>
+// {
+// "instances": [
+// ["the","quick","brown"],
+// ["la","bruja","le"],
+// ...
+// ]
+// }
+// </pre>
+// Floating point scalar values:
+// <pre>
+// {"instances": [0.0, 1.1, 2.2]}
+// </pre>
+// Vectors of integers:
+// <pre>
+// {
+// "instances": [
+// [0, 1, 2],
+// [3, 4, 5],
+// ...
+// ]
+// }
+// </pre>
+// Tensors (in this case, two-dimensional tensors):
+// <pre>
+// {
+// "instances": [
+// [
+// [0, 1, 2],
+// [3, 4, 5]
+// ],
+// ...
+// ]
+// }
+// </pre>
+// Images can be represented different ways. In this encoding scheme the
+// first
+// two dimensions represent the rows and columns of the image, and the
+// third
+// contains lists (vectors) of the R, G, and B values for each
+// pixel.
+// <pre>
+// {
+// "instances": [
+// [
+// [
+// [138, 30, 66],
+// [130, 20, 56],
+// ...
+// ],
+// [
+// [126, 38, 61],
+// [122, 24, 57],
+// ...
+// ],
+// ...
+// ],
+// ...
+// ]
+// }
+// </pre>
+// JSON strings must be encoded as UTF-8. To send binary data, you
+// must
+// base64-encode the data and mark it as binary. To mark a JSON
+// string
+// as binary, replace it with a JSON object with a single attribute
+// named `b64`:
+// <pre>{"b64": "..."} </pre>
+// For example:
+//
+// Two Serialized tf.Examples (fake data, for illustrative purposes
+// only):
+// <pre>
+// {"instances": [{"b64": "X5ad6u"}, {"b64": "IA9j4nx"}]}
+// </pre>
+// Two JPEG image byte strings (fake data, for illustrative purposes
+// only):
+// <pre>
+// {"instances": [{"b64": "ASa8asdf"}, {"b64": "JLK7ljk3"}]}
+// </pre>
+// If your data includes named references, format each instance as a
+// JSON object
+// with the named references as the keys:
+//
+// JSON input data to be preprocessed:
+// <pre>
+// {
+// "instances": [
+// {
+// "a": 1.0,
+// "b": true,
+// "c": "x"
+// },
+// {
+// "a": -2.0,
+// "b": false,
+// "c": "y"
+// }
+// ]
+// }
+// </pre>
+// Some models have an underlying TensorFlow graph that accepts multiple
+// input
+// tensors. In this case, you should use the names of JSON name/value
+// pairs to
+// identify the input tensors, as shown in the following exmaples:
+//
+// For a graph with input tensor aliases "tag" (string) and
+// "image"
+// (base64-encoded string):
+// <pre>
+// {
+// "instances": [
+// {
+// "tag": "beach",
+// "image": {"b64": "ASa8asdf"}
+// },
+// {
+// "tag": "car",
+// "image": {"b64": "JLK7ljk3"}
+// }
+// ]
+// }
+// </pre>
+// For a graph with input tensor aliases "tag" (string) and
+// "image"
+// (3-dimensional array of 8-bit ints):
+// <pre>
+// {
+// "instances": [
+// {
+// "tag": "beach",
+// "image": [
+// [
+// [138, 30, 66],
+// [130, 20, 56],
+// ...
+// ],
+// [
+// [126, 38, 61],
+// [122, 24, 57],
+// ...
+// ],
+// ...
+// ]
+// },
+// {
+// "tag": "car",
+// "image": [
+// [
+// [255, 0, 102],
+// [255, 0, 97],
+// ...
+// ],
+// [
+// [254, 1, 101],
+// [254, 2, 93],
+// ...
+// ],
+// ...
+// ]
+// },
+// ...
+// ]
+// }
+// </pre>
+// If the call is successful, the response body will contain one
+// prediction
+// entry per instance in the request body. If prediction fails for
+// any
+// instance, the response body will contain no predictions and will
+// contian
+// a single error entry instead.
+type GoogleCloudMlV1__PredictRequest struct {
+ // HttpBody:
+ // Required. The prediction request body.
+ HttpBody *GoogleApi__HttpBody `json:"httpBody,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "HttpBody") 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. "HttpBody") 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 *GoogleCloudMlV1__PredictRequest) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__PredictRequest
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__PredictionInput: Represents input parameters for a
+// prediction job.
+type GoogleCloudMlV1__PredictionInput struct {
+ // DataFormat: Required. The format of the input data files.
+ //
+ // Possible values:
+ // "DATA_FORMAT_UNSPECIFIED" - Unspecified format.
+ // "TEXT" - The source file is a text file with instances separated by
+ // the
+ // new-line character.
+ // "TF_RECORD" - The source file is a TFRecord file.
+ // "TF_RECORD_GZIP" - The source file is a GZIP-compressed TFRecord
+ // file.
+ DataFormat string `json:"dataFormat,omitempty"`
+
+ // InputPaths: Required. The Google Cloud Storage location of the input
+ // data files.
+ // May contain wildcards.
+ InputPaths []string `json:"inputPaths,omitempty"`
+
+ // MaxWorkerCount: Optional. The maximum number of workers to be used
+ // for parallel processing.
+ // Defaults to 10 if not specified.
+ MaxWorkerCount int64 `json:"maxWorkerCount,omitempty,string"`
+
+ // ModelName: Use this field if you want to use the default version for
+ // the specified
+ // model. The string must use the following
+ // format:
+ //
+ // "projects/<var>[YOUR_PROJECT]</var>/models/<var>[YOUR_MODEL]
+ // </var>"
+ ModelName string `json:"modelName,omitempty"`
+
+ // OutputPath: Required. The output Google Cloud Storage location.
+ OutputPath string `json:"outputPath,omitempty"`
+
+ // Region: Required. The Google Compute Engine region to run the
+ // prediction job in.
+ Region string `json:"region,omitempty"`
+
+ // RuntimeVersion: Optional. The Google Cloud ML runtime version to use
+ // for this batch
+ // prediction. If not set, Google Cloud ML will pick the runtime version
+ // used
+ // during the CreateVersion request for this model version, or choose
+ // the
+ // latest stable version when model version information is not
+ // available
+ // such as when the model is specified by uri.
+ RuntimeVersion string `json:"runtimeVersion,omitempty"`
+
+ // Uri: Use this field if you want to specify a Google Cloud Storage
+ // path for
+ // the model to use.
+ Uri string `json:"uri,omitempty"`
+
+ // VersionName: Use this field if you want to specify a version of the
+ // model to use. The
+ // string is formatted the same way as `model_version`, with the
+ // addition
+ // of the version
+ // information:
+ //
+ // "projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MO
+ // DEL/versions/<var>[YOUR_VERSION]</var>"
+ VersionName string `json:"versionName,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "DataFormat") 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. "DataFormat") 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 *GoogleCloudMlV1__PredictionInput) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__PredictionInput
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__PredictionOutput: Represents results of a prediction
+// job.
+type GoogleCloudMlV1__PredictionOutput struct {
+ // ErrorCount: The number of data instances which resulted in errors.
+ ErrorCount int64 `json:"errorCount,omitempty,string"`
+
+ // NodeHours: Node hours used by the batch prediction job.
+ NodeHours float64 `json:"nodeHours,omitempty"`
+
+ // OutputPath: The output Google Cloud Storage location provided at the
+ // job creation time.
+ OutputPath string `json:"outputPath,omitempty"`
+
+ // PredictionCount: The number of generated predictions.
+ PredictionCount int64 `json:"predictionCount,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "ErrorCount") 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. "ErrorCount") 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 *GoogleCloudMlV1__PredictionOutput) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__PredictionOutput
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *GoogleCloudMlV1__PredictionOutput) UnmarshalJSON(data []byte) error {
+ type noMethod GoogleCloudMlV1__PredictionOutput
+ var s1 struct {
+ NodeHours gensupport.JSONFloat64 `json:"nodeHours"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.NodeHours = float64(s1.NodeHours)
+ return nil
+}
+
+// GoogleCloudMlV1__SetDefaultVersionRequest: Request message for the
+// SetDefaultVersion request.
+type GoogleCloudMlV1__SetDefaultVersionRequest struct {
+}
+
+// GoogleCloudMlV1__TrainingInput: Represents input parameters for a
+// training job.
+type GoogleCloudMlV1__TrainingInput struct {
+ // Args: Optional. Command line arguments to pass to the program.
+ Args []string `json:"args,omitempty"`
+
+ // Hyperparameters: Optional. The set of Hyperparameters to tune.
+ Hyperparameters *GoogleCloudMlV1__HyperparameterSpec `json:"hyperparameters,omitempty"`
+
+ // JobDir: Optional. A Google Cloud Storage path in which to store
+ // training outputs
+ // and other data needed for training. This path is passed to your
+ // TensorFlow
+ // program as the 'job_dir' command-line argument. The benefit of
+ // specifying
+ // this field is that Cloud ML validates the path for use in training.
+ JobDir string `json:"jobDir,omitempty"`
+
+ // MasterType: Optional. Specifies the type of virtual machine to use
+ // for your training
+ // job's master worker.
+ //
+ // The following types are supported:
+ //
+ // <dl>
+ // <dt>standard</dt>
+ // <dd>
+ // A basic machine configuration suitable for training simple models
+ // with
+ // small to moderate datasets.
+ // </dd>
+ // <dt>large_model</dt>
+ // <dd>
+ // A machine with a lot of memory, specially suited for parameter
+ // servers
+ // when your model is large (having many hidden layers or layers with
+ // very
+ // large numbers of nodes).
+ // </dd>
+ // <dt>complex_model_s</dt>
+ // <dd>
+ // A machine suitable for the master and workers of the cluster when
+ // your
+ // model requires more computation than the standard machine can
+ // handle
+ // satisfactorily.
+ // </dd>
+ // <dt>complex_model_m</dt>
+ // <dd>
+ // A machine with roughly twice the number of cores and roughly double
+ // the
+ // memory of <code suppresswarning="true">complex_model_s</code>.
+ // </dd>
+ // <dt>complex_model_l</dt>
+ // <dd>
+ // A machine with roughly twice the number of cores and roughly double
+ // the
+ // memory of <code suppresswarning="true">complex_model_m</code>.
+ // </dd>
+ // <dt>standard_gpu</dt>
+ // <dd>
+ // A machine equivalent to <code
+ // suppresswarning="true">standard</code> that
+ // also includes a
+ // <a href="ml/docs/how-tos/using-gpus">
+ // GPU that you can use in your trainer</a>.
+ // </dd>
+ // <dt>complex_model_m_gpu</dt>
+ // <dd>
+ // A machine equivalent to
+ // <code suppresswarning="true">coplex_model_m</code> that also
+ // includes
+ // four GPUs.
+ // </dd>
+ // </dl>
+ //
+ // You must set this value when `scaleTier` is set to `CUSTOM`.
+ MasterType string `json:"masterType,omitempty"`
+
+ // PackageUris: Required. The Google Cloud Storage location of the
+ // packages with
+ // the training program and any additional dependencies.
+ PackageUris []string `json:"packageUris,omitempty"`
+
+ // ParameterServerCount: Optional. The number of parameter server
+ // replicas to use for the training
+ // job. Each replica in the cluster will be of the type specified
+ // in
+ // `parameter_server_type`.
+ //
+ // This value can only be used when `scale_tier` is set to `CUSTOM`.If
+ // you
+ // set this value, you must also set `parameter_server_type`.
+ ParameterServerCount int64 `json:"parameterServerCount,omitempty,string"`
+
+ // ParameterServerType: Optional. Specifies the type of virtual machine
+ // to use for your training
+ // job's parameter server.
+ //
+ // The supported values are the same as those described in the entry
+ // for
+ // `master_type`.
+ //
+ // This value must be present when `scaleTier` is set to `CUSTOM`
+ // and
+ // `parameter_server_count` is greater than zero.
+ ParameterServerType string `json:"parameterServerType,omitempty"`
+
+ // PythonModule: Required. The Python module name to run after
+ // installing the packages.
+ PythonModule string `json:"pythonModule,omitempty"`
+
+ // Region: Required. The Google Compute Engine region to run the
+ // training job in.
+ Region string `json:"region,omitempty"`
+
+ // RuntimeVersion: Optional. The Google Cloud ML runtime version to use
+ // for training. If not
+ // set, Google Cloud ML will choose the latest stable version.
+ RuntimeVersion string `json:"runtimeVersion,omitempty"`
+
+ // ScaleTier: Required. Specifies the machine types, the number of
+ // replicas for workers
+ // and parameter servers.
+ //
+ // Possible values:
+ // "BASIC" - A single worker instance. This tier is suitable for
+ // learning how to use
+ // Cloud ML, and for experimenting with new models using small datasets.
+ // "STANDARD_1" - Many workers and a few parameter servers.
+ // "PREMIUM_1" - A large number of workers with many parameter
+ // servers.
+ // "BASIC_GPU" - A single worker instance [with a
+ // GPU](ml/docs/how-tos/using-gpus).
+ // "CUSTOM" - The CUSTOM tier is not a set tier, but rather enables
+ // you to use your
+ // own cluster specification. When you use this tier, set values
+ // to
+ // configure your processing cluster according to these guidelines:
+ //
+ // * You _must_ set `TrainingInput.masterType` to specify the type
+ // of machine to use for your master node. This is the only
+ // required
+ // setting.
+ //
+ // * You _may_ set `TrainingInput.workerCount` to specify the number
+ // of
+ // workers to use. If you specify one or more workers, you _must_
+ // also
+ // set `TrainingInput.workerType` to specify the type of machine to
+ // use
+ // for your worker nodes.
+ //
+ // * You _may_ set `TrainingInput.parameterServerCount` to specify
+ // the
+ // number of parameter servers to use. If you specify one or more
+ // parameter servers, you _must_ also set
+ // `TrainingInput.parameterServerType` to specify the type of
+ // machine to
+ // use for your parameter servers.
+ //
+ // Note that all of your workers must use the same machine type, which
+ // can
+ // be different from your parameter server type and master type.
+ // Your
+ // parameter servers must likewise use the same machine type, which can
+ // be
+ // different from your worker type and master type.
+ ScaleTier string `json:"scaleTier,omitempty"`
+
+ // WorkerCount: Optional. The number of worker replicas to use for the
+ // training job. Each
+ // replica in the cluster will be of the type specified in
+ // `worker_type`.
+ //
+ // This value can only be used when `scale_tier` is set to `CUSTOM`. If
+ // you
+ // set this value, you must also set `worker_type`.
+ WorkerCount int64 `json:"workerCount,omitempty,string"`
+
+ // WorkerType: Optional. Specifies the type of virtual machine to use
+ // for your training
+ // job's worker nodes.
+ //
+ // The supported values are the same as those described in the entry
+ // for
+ // `masterType`.
+ //
+ // This value must be present when `scaleTier` is set to `CUSTOM`
+ // and
+ // `workerCount` is greater than zero.
+ WorkerType string `json:"workerType,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Args") 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. "Args") 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 *GoogleCloudMlV1__TrainingInput) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__TrainingInput
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1__TrainingOutput: Represents results of a training
+// job. Output only.
+type GoogleCloudMlV1__TrainingOutput struct {
+ // CompletedTrialCount: The number of hyperparameter tuning trials that
+ // completed successfully.
+ // Only set for hyperparameter tuning jobs.
+ CompletedTrialCount int64 `json:"completedTrialCount,omitempty,string"`
+
+ // ConsumedMLUnits: The amount of ML units consumed by the job.
+ ConsumedMLUnits float64 `json:"consumedMLUnits,omitempty"`
+
+ // IsHyperparameterTuningJob: Whether this job is a hyperparameter
+ // tuning job.
+ IsHyperparameterTuningJob bool `json:"isHyperparameterTuningJob,omitempty"`
+
+ // Trials: Results for individual Hyperparameter trials.
+ // Only set for hyperparameter tuning jobs.
+ Trials []*GoogleCloudMlV1__HyperparameterOutput `json:"trials,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CompletedTrialCount")
+ // 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. "CompletedTrialCount") 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 *GoogleCloudMlV1__TrainingOutput) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__TrainingOutput
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+func (s *GoogleCloudMlV1__TrainingOutput) UnmarshalJSON(data []byte) error {
+ type noMethod GoogleCloudMlV1__TrainingOutput
+ var s1 struct {
+ ConsumedMLUnits gensupport.JSONFloat64 `json:"consumedMLUnits"`
+ *noMethod
+ }
+ s1.noMethod = (*noMethod)(s)
+ if err := json.Unmarshal(data, &s1); err != nil {
+ return err
+ }
+ s.ConsumedMLUnits = float64(s1.ConsumedMLUnits)
+ return nil
+}
+
+// GoogleCloudMlV1__Version: Represents a version of the model.
+//
+// Each version is a trained model deployed in the cloud, ready to
+// handle
+// prediction requests. A model can have multiple versions. You can
+// get
+// information about all of the versions of a given model by
+// calling
+// [projects.models.versions.list](/ml/reference/rest/v1/projects
+// .models.versions/list).
+type GoogleCloudMlV1__Version struct {
+ // CreateTime: Output only. The time the version was created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // DeploymentUri: Required. The Google Cloud Storage location of the
+ // trained model used to
+ // create the version. See the
+ // [overview of model deployment](/ml/docs/concepts/deployment-overview)
+ // for
+ // more informaiton.
+ //
+ // When passing Version
+ // to
+ // [projects.models.versions.create](/ml/reference/rest/v1/projects.mo
+ // dels.versions/create)
+ // the model service uses the specified location as the source of the
+ // model.
+ // Once deployed, the model version is hosted by the prediction service,
+ // so
+ // this location is useful only as a historical record.
+ DeploymentUri string `json:"deploymentUri,omitempty"`
+
+ // Description: Optional. The description specified for the version when
+ // it was created.
+ Description string `json:"description,omitempty"`
+
+ // IsDefault: Output only. If true, this version will be used to handle
+ // prediction
+ // requests that do not specify a version.
+ //
+ // You can change the default version by
+ // calling
+ // [projects.methods.versions.setDefault](/ml/reference/rest/v1/p
+ // rojects.models.versions/setDefault).
+ IsDefault bool `json:"isDefault,omitempty"`
+
+ // LastUseTime: Output only. The time the version was last used for
+ // prediction.
+ LastUseTime string `json:"lastUseTime,omitempty"`
+
+ // ManualScaling: Optional. Manually select the number of nodes to use
+ // for serving the
+ // model. If unset (i.e., by default), the number of nodes used to
+ // serve
+ // the model automatically scales with traffic. However, care should
+ // be
+ // taken to ramp up traffic according to the model's ability to scale.
+ // If
+ // your model needs to handle bursts of traffic beyond it's ability
+ // to
+ // scale, it is recommended you set this field appropriately.
+ ManualScaling *GoogleCloudMlV1__ManualScaling `json:"manualScaling,omitempty"`
+
+ // Name: Required.The name specified for the version when it was
+ // created.
+ //
+ // The version name must be unique within the model it is created in.
+ Name string `json:"name,omitempty"`
+
+ // RuntimeVersion: Optional. The Google Cloud ML runtime version to use
+ // for this deployment.
+ // If not set, Google Cloud ML will choose a version.
+ RuntimeVersion string `json:"runtimeVersion,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleCloudMlV1__Version) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1__Version
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1beta1__ManualScaling: Options for manually scaling a
+// model.
+type GoogleCloudMlV1beta1__ManualScaling struct {
+ // Nodes: The number of nodes to allocate for this model. These nodes
+ // are always up,
+ // starting from the time the model is deployed, so the cost of
+ // operating
+ // this model will be proportional to nodes * number of hours
+ // since
+ // deployment.
+ Nodes int64 `json:"nodes,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Nodes") 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. "Nodes") 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 *GoogleCloudMlV1beta1__ManualScaling) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1beta1__ManualScaling
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1beta1__OperationMetadata: Represents the metadata of
+// the long-running operation.
+type GoogleCloudMlV1beta1__OperationMetadata struct {
+ // CreateTime: The time the operation was submitted.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // EndTime: The time operation processing completed.
+ EndTime string `json:"endTime,omitempty"`
+
+ // IsCancellationRequested: Indicates whether a request to cancel this
+ // operation has been made.
+ IsCancellationRequested bool `json:"isCancellationRequested,omitempty"`
+
+ // ModelName: Contains the name of the model associated with the
+ // operation.
+ ModelName string `json:"modelName,omitempty"`
+
+ // OperationType: The operation type.
+ //
+ // Possible values:
+ // "OPERATION_TYPE_UNSPECIFIED" - Unspecified operation type.
+ // "CREATE_VERSION" - An operation to create a new version.
+ // "DELETE_VERSION" - An operation to delete an existing version.
+ // "DELETE_MODEL" - An operation to delete an existing model.
+ OperationType string `json:"operationType,omitempty"`
+
+ // StartTime: The time operation processing started.
+ StartTime string `json:"startTime,omitempty"`
+
+ // Version: Contains the version associated with the operation.
+ Version *GoogleCloudMlV1beta1__Version `json:"version,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleCloudMlV1beta1__OperationMetadata) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1beta1__OperationMetadata
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleCloudMlV1beta1__Version: Represents a version of the
+// model.
+//
+// Each version is a trained model deployed in the cloud, ready to
+// handle
+// prediction requests. A model can have multiple versions. You can
+// get
+// information about all of the versions of a given model by
+// calling
+// [projects.models.versions.list](/ml/reference/rest/v1beta1/pro
+// jects.models.versions/list).
+type GoogleCloudMlV1beta1__Version struct {
+ // CreateTime: Output only. The time the version was created.
+ CreateTime string `json:"createTime,omitempty"`
+
+ // DeploymentUri: Required. The Google Cloud Storage location of the
+ // trained model used to
+ // create the version. See the
+ // [overview of model deployment](/ml/docs/concepts/deployment-overview)
+ // for
+ // more informaiton.
+ //
+ // When passing Version
+ // to
+ // [projects.models.versions.create](/ml/reference/rest/v1beta1/projec
+ // ts.models.versions/create)
+ // the model service uses the specified location as the source of the
+ // model.
+ // Once deployed, the model version is hosted by the prediction service,
+ // so
+ // this location is useful only as a historical record.
+ DeploymentUri string `json:"deploymentUri,omitempty"`
+
+ // Description: Optional. The description specified for the version when
+ // it was created.
+ Description string `json:"description,omitempty"`
+
+ // IsDefault: Output only. If true, this version will be used to handle
+ // prediction
+ // requests that do not specify a version.
+ //
+ // You can change the default version by
+ // calling
+ // [projects.methods.versions.setDefault](/ml/reference/rest/v1be
+ // ta1/projects.models.versions/setDefault).
+ IsDefault bool `json:"isDefault,omitempty"`
+
+ // LastUseTime: Output only. The time the version was last used for
+ // prediction.
+ LastUseTime string `json:"lastUseTime,omitempty"`
+
+ // ManualScaling: Optional. Manually select the number of nodes to use
+ // for serving the
+ // model. If unset (i.e., by default), the number of nodes used to
+ // serve
+ // the model automatically scales with traffic. However, care should
+ // be
+ // taken to ramp up traffic according to the model's ability to scale.
+ // If
+ // your model needs to handle bursts of traffic beyond it's ability
+ // to
+ // scale, it is recommended you set this field appropriately.
+ ManualScaling *GoogleCloudMlV1beta1__ManualScaling `json:"manualScaling,omitempty"`
+
+ // Name: Required.The name specified for the version when it was
+ // created.
+ //
+ // The version name must be unique within the model it is created in.
+ Name string `json:"name,omitempty"`
+
+ // RuntimeVersion: Optional. The Google Cloud ML runtime version to use
+ // for this deployment.
+ // If not set, Google Cloud ML will choose a version.
+ RuntimeVersion string `json:"runtimeVersion,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "CreateTime") 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. "CreateTime") 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 *GoogleCloudMlV1beta1__Version) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleCloudMlV1beta1__Version
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleLongrunning__ListOperationsResponse: The response message for
+// Operations.ListOperations.
+type GoogleLongrunning__ListOperationsResponse struct {
+ // NextPageToken: The standard List next-page token.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Operations: A list of operations that matches the specified filter in
+ // the request.
+ Operations []*GoogleLongrunning__Operation `json:"operations,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 *GoogleLongrunning__ListOperationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleLongrunning__ListOperationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleLongrunning__Operation: This resource represents a long-running
+// operation that is the result of a
+// network API call.
+type GoogleLongrunning__Operation struct {
+ // Done: 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.
+ Done bool `json:"done,omitempty"`
+
+ // Error: The error result of the operation in case of failure or
+ // cancellation.
+ Error *GoogleRpc__Status `json:"error,omitempty"`
+
+ // Metadata: 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.
+ Metadata googleapi.RawMessage `json:"metadata,omitempty"`
+
+ // Name: 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`.
+ Name string `json:"name,omitempty"`
+
+ // Response: 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`.
+ Response googleapi.RawMessage `json:"response,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Done") 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. "Done") 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 *GoogleLongrunning__Operation) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleLongrunning__Operation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// GoogleProtobuf__Empty: 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:
+//
+// service Foo {
+// rpc Bar(google.protobuf.Empty) returns
+// (google.protobuf.Empty);
+// }
+//
+// The JSON representation for `Empty` is empty JSON object `{}`.
+type GoogleProtobuf__Empty struct {
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+}
+
+// GoogleRpc__Status: 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:
+//
+// - Simple to use and understand for most users
+// - Flexible enough to meet unexpected needs
+//
+// # Overview
+//
+// The `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` which can be used for common error
+// conditions.
+//
+// # Language mapping
+//
+// The `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 uses
+//
+// The 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:
+//
+// - Partial 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.
+//
+// - Workflow errors. A typical workflow has multiple steps. Each step
+// may
+// have a `Status` message for error reporting purpose.
+//
+// - Batch 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.
+//
+// - Asynchronous 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.
+//
+// - Logging. If some API errors are stored in logs, the message
+// `Status` could
+// be used directly after any stripping needed for security/privacy
+// reasons.
+type GoogleRpc__Status struct {
+ // Code: The status code, which should be an enum value of
+ // google.rpc.Code.
+ Code int64 `json:"code,omitempty"`
+
+ // Details: A list of messages that carry the error details. There will
+ // be a
+ // common set of message types for APIs to use.
+ Details []googleapi.RawMessage `json:"details,omitempty"`
+
+ // Message: 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.
+ Message string `json:"message,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Code") 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. "Code") 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 *GoogleRpc__Status) MarshalJSON() ([]byte, error) {
+ type noMethod GoogleRpc__Status
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "ml.projects.getConfig":
+
+type ProjectsGetConfigCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetConfig: Get the service account information associated with your
+// project. You need
+// this information in order to grant the service account persmissions
+// for
+// the Google Cloud Storage location where you put your model training
+// code
+// for training the model with Google Cloud Machine Learning.
+func (r *ProjectsService) GetConfig(name string) *ProjectsGetConfigCall {
+ c := &ProjectsGetConfigCall{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 *ProjectsGetConfigCall) Fields(s ...googleapi.Field) *ProjectsGetConfigCall {
+ 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 *ProjectsGetConfigCall) IfNoneMatch(entityTag string) *ProjectsGetConfigCall {
+ 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 *ProjectsGetConfigCall) Context(ctx context.Context) *ProjectsGetConfigCall {
+ 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 *ProjectsGetConfigCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsGetConfigCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+name}:getConfig")
+ 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 "ml.projects.getConfig" call.
+// Exactly one of *GoogleCloudMlV1__GetConfigResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleCloudMlV1__GetConfigResponse.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 *ProjectsGetConfigCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__GetConfigResponse, 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 := &GoogleCloudMlV1__GetConfigResponse{
+ 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": "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.",
+ // "flatPath": "v1/projects/{projectsId}:getConfig",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.getConfig",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:getConfig",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__GetConfigResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.predict":
+
+type ProjectsPredictCall struct {
+ s *Service
+ name string
+ googlecloudmlv1__predictrequest *GoogleCloudMlV1__PredictRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Predict: Performs prediction on the data in the request.
+//
+// **** REMOVE FROM GENERATED DOCUMENTATION
+func (r *ProjectsService) Predict(name string, googlecloudmlv1__predictrequest *GoogleCloudMlV1__PredictRequest) *ProjectsPredictCall {
+ c := &ProjectsPredictCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.googlecloudmlv1__predictrequest = googlecloudmlv1__predictrequest
+ 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 *ProjectsPredictCall) Fields(s ...googleapi.Field) *ProjectsPredictCall {
+ 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 *ProjectsPredictCall) Context(ctx context.Context) *ProjectsPredictCall {
+ 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 *ProjectsPredictCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsPredictCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__predictrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:predict")
+ 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 "ml.projects.predict" call.
+// Exactly one of *GoogleApi__HttpBody or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleApi__HttpBody.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 *ProjectsPredictCall) Do(opts ...googleapi.CallOption) (*GoogleApi__HttpBody, 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 := &GoogleApi__HttpBody{
+ 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": "Performs prediction on the data in the request.\n\n**** REMOVE FROM GENERATED DOCUMENTATION",
+ // "flatPath": "v1/projects/{projectsId}:predict",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.predict",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/.+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:predict",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__PredictRequest"
+ // },
+ // "response": {
+ // "$ref": "GoogleApi__HttpBody"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.jobs.cancel":
+
+type ProjectsJobsCancelCall struct {
+ s *Service
+ name string
+ googlecloudmlv1__canceljobrequest *GoogleCloudMlV1__CancelJobRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Cancel: Cancels a running job.
+func (r *ProjectsJobsService) Cancel(name string, googlecloudmlv1__canceljobrequest *GoogleCloudMlV1__CancelJobRequest) *ProjectsJobsCancelCall {
+ c := &ProjectsJobsCancelCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.googlecloudmlv1__canceljobrequest = googlecloudmlv1__canceljobrequest
+ 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 *ProjectsJobsCancelCall) Fields(s ...googleapi.Field) *ProjectsJobsCancelCall {
+ 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 *ProjectsJobsCancelCall) Context(ctx context.Context) *ProjectsJobsCancelCall {
+ 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 *ProjectsJobsCancelCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsJobsCancelCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__canceljobrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel")
+ 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 "ml.projects.jobs.cancel" call.
+// Exactly one of *GoogleProtobuf__Empty or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleProtobuf__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 *ProjectsJobsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobuf__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 := &GoogleProtobuf__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": "Cancels a running job.",
+ // "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.jobs.cancel",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the job to cancel.\n\nAuthorization: requires `Editor` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:cancel",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__CancelJobRequest"
+ // },
+ // "response": {
+ // "$ref": "GoogleProtobuf__Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.jobs.create":
+
+type ProjectsJobsCreateCall struct {
+ s *Service
+ parent string
+ googlecloudmlv1__job *GoogleCloudMlV1__Job
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a training or a batch prediction job.
+func (r *ProjectsJobsService) Create(parent string, googlecloudmlv1__job *GoogleCloudMlV1__Job) *ProjectsJobsCreateCall {
+ c := &ProjectsJobsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.googlecloudmlv1__job = googlecloudmlv1__job
+ 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 *ProjectsJobsCreateCall) Fields(s ...googleapi.Field) *ProjectsJobsCreateCall {
+ 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 *ProjectsJobsCreateCall) Context(ctx context.Context) *ProjectsJobsCreateCall {
+ 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 *ProjectsJobsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsJobsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__job)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/jobs")
+ 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 "ml.projects.jobs.create" call.
+// Exactly one of *GoogleCloudMlV1__Job or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Job.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 *ProjectsJobsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Job, 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 := &GoogleCloudMlV1__Job{
+ 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 training or a batch prediction job.",
+ // "flatPath": "v1/projects/{projectsId}/jobs",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.jobs.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/jobs",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__Job"
+ // },
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Job"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.jobs.get":
+
+type ProjectsJobsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Describes a job.
+func (r *ProjectsJobsService) Get(name string) *ProjectsJobsGetCall {
+ c := &ProjectsJobsGetCall{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 *ProjectsJobsGetCall) Fields(s ...googleapi.Field) *ProjectsJobsGetCall {
+ 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 *ProjectsJobsGetCall) IfNoneMatch(entityTag string) *ProjectsJobsGetCall {
+ 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 *ProjectsJobsGetCall) Context(ctx context.Context) *ProjectsJobsGetCall {
+ 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 *ProjectsJobsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsJobsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "ml.projects.jobs.get" call.
+// Exactly one of *GoogleCloudMlV1__Job or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Job.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 *ProjectsJobsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Job, 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 := &GoogleCloudMlV1__Job{
+ 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": "Describes a job.",
+ // "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.jobs.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the job to get the description of.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Job"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.jobs.list":
+
+type ProjectsJobsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the jobs in the project.
+func (r *ProjectsJobsService) List(parent string) *ProjectsJobsListCall {
+ c := &ProjectsJobsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// Filter sets the optional parameter "filter": Specifies the subset of
+// jobs to retrieve.
+func (c *ProjectsJobsListCall) Filter(filter string) *ProjectsJobsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The number of jobs
+// to retrieve per "page" of results. If there
+// are more remaining results than this number, the response message
+// will
+// contain a valid value in the `next_page_token` field.
+//
+// The default value is 20, and the maximum page size is 100.
+func (c *ProjectsJobsListCall) PageSize(pageSize int64) *ProjectsJobsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A page token to
+// request the next page of results.
+//
+// You get the token from the `next_page_token` field of the response
+// from
+// the previous call.
+func (c *ProjectsJobsListCall) PageToken(pageToken string) *ProjectsJobsListCall {
+ 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 *ProjectsJobsListCall) Fields(s ...googleapi.Field) *ProjectsJobsListCall {
+ 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 *ProjectsJobsListCall) IfNoneMatch(entityTag string) *ProjectsJobsListCall {
+ 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 *ProjectsJobsListCall) Context(ctx context.Context) *ProjectsJobsListCall {
+ 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 *ProjectsJobsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsJobsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/jobs")
+ 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 "ml.projects.jobs.list" call.
+// Exactly one of *GoogleCloudMlV1__ListJobsResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleCloudMlV1__ListJobsResponse.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 *ProjectsJobsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__ListJobsResponse, 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 := &GoogleCloudMlV1__ListJobsResponse{
+ 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 jobs in the project.",
+ // "flatPath": "v1/projects/{projectsId}/jobs",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.jobs.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "Optional. Specifies the subset of jobs to retrieve.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The name of the project for which to list jobs.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/jobs",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__ListJobsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsJobsListCall) Pages(ctx context.Context, f func(*GoogleCloudMlV1__ListJobsResponse) 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 "ml.projects.models.create":
+
+type ProjectsModelsCreateCall struct {
+ s *Service
+ parent string
+ googlecloudmlv1__model *GoogleCloudMlV1__Model
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a model which will later contain one or more
+// versions.
+//
+// You must add at least one version before you can request predictions
+// from
+// the model. Add versions by
+// calling
+// [projects.models.versions.create](/ml/reference/rest/v1/projec
+// ts.models.versions/create).
+func (r *ProjectsModelsService) Create(parent string, googlecloudmlv1__model *GoogleCloudMlV1__Model) *ProjectsModelsCreateCall {
+ c := &ProjectsModelsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.googlecloudmlv1__model = googlecloudmlv1__model
+ 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 *ProjectsModelsCreateCall) Fields(s ...googleapi.Field) *ProjectsModelsCreateCall {
+ 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 *ProjectsModelsCreateCall) Context(ctx context.Context) *ProjectsModelsCreateCall {
+ 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 *ProjectsModelsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__model)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/models")
+ 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 "ml.projects.models.create" call.
+// Exactly one of *GoogleCloudMlV1__Model or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Model.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 *ProjectsModelsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Model, 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 := &GoogleCloudMlV1__Model{
+ 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 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/reference/rest/v1/projects.models.versions/create).",
+ // "flatPath": "v1/projects/{projectsId}/models",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.models.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/models",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__Model"
+ // },
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Model"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.delete":
+
+type ProjectsModelsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a model.
+//
+// You can only delete a model if there are no versions in it. You can
+// delete
+// versions by
+// calling
+// [projects.models.versions.delete](/ml/reference/rest/v1/projec
+// ts.models.versions/delete).
+func (r *ProjectsModelsService) Delete(name string) *ProjectsModelsDeleteCall {
+ c := &ProjectsModelsDeleteCall{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 *ProjectsModelsDeleteCall) Fields(s ...googleapi.Field) *ProjectsModelsDeleteCall {
+ 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 *ProjectsModelsDeleteCall) Context(ctx context.Context) *ProjectsModelsDeleteCall {
+ 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 *ProjectsModelsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsDeleteCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+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 "ml.projects.models.delete" call.
+// Exactly one of *GoogleLongrunning__Operation or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleLongrunning__Operation.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 *ProjectsModelsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunning__Operation, 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 := &GoogleLongrunning__Operation{
+ 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 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/reference/rest/v1/projects.models.versions/delete).",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ // "httpMethod": "DELETE",
+ // "id": "ml.projects.models.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleLongrunning__Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.get":
+
+type ProjectsModelsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets information about a model, including its name, the
+// description (if
+// set), and the default version (if at least one version of the model
+// has
+// been deployed).
+func (r *ProjectsModelsService) Get(name string) *ProjectsModelsGetCall {
+ c := &ProjectsModelsGetCall{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 *ProjectsModelsGetCall) Fields(s ...googleapi.Field) *ProjectsModelsGetCall {
+ 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 *ProjectsModelsGetCall) IfNoneMatch(entityTag string) *ProjectsModelsGetCall {
+ 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 *ProjectsModelsGetCall) Context(ctx context.Context) *ProjectsModelsGetCall {
+ 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 *ProjectsModelsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "ml.projects.models.get" call.
+// Exactly one of *GoogleCloudMlV1__Model or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Model.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 *ProjectsModelsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Model, 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 := &GoogleCloudMlV1__Model{
+ 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 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).",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.models.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Model"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.list":
+
+type ProjectsModelsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the models in a project.
+//
+// Each project can contain multiple models, and each model can have
+// multiple
+// versions.
+func (r *ProjectsModelsService) List(parent string) *ProjectsModelsListCall {
+ c := &ProjectsModelsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The number of models
+// to retrieve per "page" of results. If there
+// are more remaining results than this number, the response message
+// will
+// contain a valid value in the `next_page_token` field.
+//
+// The default value is 20, and the maximum page size is 100.
+func (c *ProjectsModelsListCall) PageSize(pageSize int64) *ProjectsModelsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A page token to
+// request the next page of results.
+//
+// You get the token from the `next_page_token` field of the response
+// from
+// the previous call.
+func (c *ProjectsModelsListCall) PageToken(pageToken string) *ProjectsModelsListCall {
+ 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 *ProjectsModelsListCall) Fields(s ...googleapi.Field) *ProjectsModelsListCall {
+ 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 *ProjectsModelsListCall) IfNoneMatch(entityTag string) *ProjectsModelsListCall {
+ 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 *ProjectsModelsListCall) Context(ctx context.Context) *ProjectsModelsListCall {
+ 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 *ProjectsModelsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/models")
+ 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 "ml.projects.models.list" call.
+// Exactly one of *GoogleCloudMlV1__ListModelsResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleCloudMlV1__ListModelsResponse.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 *ProjectsModelsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__ListModelsResponse, 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 := &GoogleCloudMlV1__ListModelsResponse{
+ 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 models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.",
+ // "flatPath": "v1/projects/{projectsId}/models",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.models.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The name of the project whose models are to be listed.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/models",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__ListModelsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsModelsListCall) Pages(ctx context.Context, f func(*GoogleCloudMlV1__ListModelsResponse) 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 "ml.projects.models.versions.create":
+
+type ProjectsModelsVersionsCreateCall struct {
+ s *Service
+ parent string
+ googlecloudmlv1__version *GoogleCloudMlV1__Version
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Create: Creates a new version of a model from a trained TensorFlow
+// model.
+//
+// If the version created in the cloud by this call is the first
+// deployed
+// version of the specified model, it will be made the default version
+// of the
+// model. When you add a version to a model that already has one or
+// more
+// versions, the default version does not automatically change. If you
+// want a
+// new version to be the default, you must
+// call
+// [projects.models.versions.setDefault](/ml/reference/rest/v1/proje
+// cts.models.versions/setDefault).
+func (r *ProjectsModelsVersionsService) Create(parent string, googlecloudmlv1__version *GoogleCloudMlV1__Version) *ProjectsModelsVersionsCreateCall {
+ c := &ProjectsModelsVersionsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ c.googlecloudmlv1__version = googlecloudmlv1__version
+ 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 *ProjectsModelsVersionsCreateCall) Fields(s ...googleapi.Field) *ProjectsModelsVersionsCreateCall {
+ 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 *ProjectsModelsVersionsCreateCall) Context(ctx context.Context) *ProjectsModelsVersionsCreateCall {
+ 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 *ProjectsModelsVersionsCreateCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsVersionsCreateCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__version)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/versions")
+ 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 "ml.projects.models.versions.create" call.
+// Exactly one of *GoogleLongrunning__Operation or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleLongrunning__Operation.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 *ProjectsModelsVersionsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunning__Operation, 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 := &GoogleLongrunning__Operation{
+ 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 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/reference/rest/v1/projects.models.versions/setDefault).",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.models.versions.create",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "parent": {
+ // "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/versions",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__Version"
+ // },
+ // "response": {
+ // "$ref": "GoogleLongrunning__Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.versions.delete":
+
+type ProjectsModelsVersionsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes a model version.
+//
+// Each model can have multiple versions deployed and in use at any
+// given
+// time. Use this method to remove a single version.
+//
+// Note: You cannot delete the version that is set as the default
+// version
+// of the model unless it is the only remaining version.
+func (r *ProjectsModelsVersionsService) Delete(name string) *ProjectsModelsVersionsDeleteCall {
+ c := &ProjectsModelsVersionsDeleteCall{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 *ProjectsModelsVersionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsModelsVersionsDeleteCall {
+ 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 *ProjectsModelsVersionsDeleteCall) Context(ctx context.Context) *ProjectsModelsVersionsDeleteCall {
+ 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 *ProjectsModelsVersionsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsVersionsDeleteCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+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 "ml.projects.models.versions.delete" call.
+// Exactly one of *GoogleLongrunning__Operation or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleLongrunning__Operation.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 *ProjectsModelsVersionsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunning__Operation, 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 := &GoogleLongrunning__Operation{
+ 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 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.",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ // "httpMethod": "DELETE",
+ // "id": "ml.projects.models.versions.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleLongrunning__Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.versions.get":
+
+type ProjectsModelsVersionsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets information about a model version.
+//
+// Models can have multiple versions. You can
+// call
+// [projects.models.versions.list](/ml/reference/rest/v1/projects.mo
+// dels.versions/list)
+// to get the same information that this method returns for all of
+// the
+// versions of a model.
+func (r *ProjectsModelsVersionsService) Get(name string) *ProjectsModelsVersionsGetCall {
+ c := &ProjectsModelsVersionsGetCall{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 *ProjectsModelsVersionsGetCall) Fields(s ...googleapi.Field) *ProjectsModelsVersionsGetCall {
+ 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 *ProjectsModelsVersionsGetCall) IfNoneMatch(entityTag string) *ProjectsModelsVersionsGetCall {
+ 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 *ProjectsModelsVersionsGetCall) Context(ctx context.Context) *ProjectsModelsVersionsGetCall {
+ 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 *ProjectsModelsVersionsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsVersionsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "ml.projects.models.versions.get" call.
+// Exactly one of *GoogleCloudMlV1__Version or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Version.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 *ProjectsModelsVersionsGetCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Version, 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 := &GoogleCloudMlV1__Version{
+ 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 information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.models.versions.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Version"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.models.versions.list":
+
+type ProjectsModelsVersionsListCall struct {
+ s *Service
+ parent string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Gets basic information about all the versions of a model.
+//
+// If you expect that a model has a lot of versions, or if you need to
+// handle
+// only a limited number of results at a time, you can request that the
+// list
+// be retrieved in batches (called pages):
+func (r *ProjectsModelsVersionsService) List(parent string) *ProjectsModelsVersionsListCall {
+ c := &ProjectsModelsVersionsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.parent = parent
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The number of
+// versions to retrieve per "page" of results. If
+// there are more remaining results than this number, the response
+// message
+// will contain a valid value in the `next_page_token` field.
+//
+// The default value is 20, and the maximum page size is 100.
+func (c *ProjectsModelsVersionsListCall) PageSize(pageSize int64) *ProjectsModelsVersionsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A page token to
+// request the next page of results.
+//
+// You get the token from the `next_page_token` field of the response
+// from
+// the previous call.
+func (c *ProjectsModelsVersionsListCall) PageToken(pageToken string) *ProjectsModelsVersionsListCall {
+ 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 *ProjectsModelsVersionsListCall) Fields(s ...googleapi.Field) *ProjectsModelsVersionsListCall {
+ 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 *ProjectsModelsVersionsListCall) IfNoneMatch(entityTag string) *ProjectsModelsVersionsListCall {
+ 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 *ProjectsModelsVersionsListCall) Context(ctx context.Context) *ProjectsModelsVersionsListCall {
+ 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 *ProjectsModelsVersionsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsVersionsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+parent}/versions")
+ 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 "ml.projects.models.versions.list" call.
+// Exactly one of *GoogleCloudMlV1__ListVersionsResponse or error will
+// be non-nil. Any non-2xx status code is an error. Response headers are
+// in either
+// *GoogleCloudMlV1__ListVersionsResponse.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 *ProjectsModelsVersionsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__ListVersionsResponse, 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 := &GoogleCloudMlV1__ListVersionsResponse{
+ 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 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):",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.models.versions.list",
+ // "parameterOrder": [
+ // "parent"
+ // ],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "parent": {
+ // "description": "Required. The name of the model for which to list the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+parent}/versions",
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__ListVersionsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsModelsVersionsListCall) Pages(ctx context.Context, f func(*GoogleCloudMlV1__ListVersionsResponse) 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 "ml.projects.models.versions.setDefault":
+
+type ProjectsModelsVersionsSetDefaultCall struct {
+ s *Service
+ name string
+ googlecloudmlv1__setdefaultversionrequest *GoogleCloudMlV1__SetDefaultVersionRequest
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// SetDefault: Designates a version to be the default for the
+// model.
+//
+// The default version is used for prediction requests made against the
+// model
+// that don't specify a version.
+//
+// The first version to be created for a model is automatically set as
+// the
+// default. You must make any subsequent changes to the default
+// version
+// setting manually using this method.
+func (r *ProjectsModelsVersionsService) SetDefault(name string, googlecloudmlv1__setdefaultversionrequest *GoogleCloudMlV1__SetDefaultVersionRequest) *ProjectsModelsVersionsSetDefaultCall {
+ c := &ProjectsModelsVersionsSetDefaultCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ c.googlecloudmlv1__setdefaultversionrequest = googlecloudmlv1__setdefaultversionrequest
+ 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 *ProjectsModelsVersionsSetDefaultCall) Fields(s ...googleapi.Field) *ProjectsModelsVersionsSetDefaultCall {
+ 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 *ProjectsModelsVersionsSetDefaultCall) Context(ctx context.Context) *ProjectsModelsVersionsSetDefaultCall {
+ 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 *ProjectsModelsVersionsSetDefaultCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsModelsVersionsSetDefaultCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.googlecloudmlv1__setdefaultversionrequest)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:setDefault")
+ 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 "ml.projects.models.versions.setDefault" call.
+// Exactly one of *GoogleCloudMlV1__Version or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GoogleCloudMlV1__Version.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 *ProjectsModelsVersionsSetDefaultCall) Do(opts ...googleapi.CallOption) (*GoogleCloudMlV1__Version, 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 := &GoogleCloudMlV1__Version{
+ 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": "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.",
+ // "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.models.versions.setDefault",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "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/reference/rest/v1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:setDefault",
+ // "request": {
+ // "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest"
+ // },
+ // "response": {
+ // "$ref": "GoogleCloudMlV1__Version"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.operations.cancel":
+
+type ProjectsOperationsCancelCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Cancel: 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`.
+func (r *ProjectsOperationsService) Cancel(name string) *ProjectsOperationsCancelCall {
+ c := &ProjectsOperationsCancelCall{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 *ProjectsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsOperationsCancelCall {
+ 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 *ProjectsOperationsCancelCall) Context(ctx context.Context) *ProjectsOperationsCancelCall {
+ 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 *ProjectsOperationsCancelCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsOperationsCancelCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:cancel")
+ 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 "ml.projects.operations.cancel" call.
+// Exactly one of *GoogleProtobuf__Empty or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleProtobuf__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 *ProjectsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*GoogleProtobuf__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 := &GoogleProtobuf__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": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ // "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel",
+ // "httpMethod": "POST",
+ // "id": "ml.projects.operations.cancel",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the operation resource to be cancelled.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}:cancel",
+ // "response": {
+ // "$ref": "GoogleProtobuf__Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.operations.delete":
+
+type ProjectsOperationsDeleteCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: 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`.
+func (r *ProjectsOperationsService) Delete(name string) *ProjectsOperationsDeleteCall {
+ c := &ProjectsOperationsDeleteCall{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 *ProjectsOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsOperationsDeleteCall {
+ 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 *ProjectsOperationsDeleteCall) Context(ctx context.Context) *ProjectsOperationsDeleteCall {
+ 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 *ProjectsOperationsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsOperationsDeleteCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+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 "ml.projects.operations.delete" call.
+// Exactly one of *GoogleProtobuf__Empty or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *GoogleProtobuf__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 *ProjectsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobuf__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 := &GoogleProtobuf__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 a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ // "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ // "httpMethod": "DELETE",
+ // "id": "ml.projects.operations.delete",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the operation resource to be deleted.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleProtobuf__Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.operations.get":
+
+type ProjectsOperationsGetCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: 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.
+func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall {
+ c := &ProjectsOperationsGetCall{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 *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall {
+ 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 *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall {
+ 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 *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall {
+ 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 *ProjectsOperationsGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsOperationsGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "ml.projects.operations.get" call.
+// Exactly one of *GoogleLongrunning__Operation or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *GoogleLongrunning__Operation.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 *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunning__Operation, 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 := &GoogleLongrunning__Operation{
+ 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 the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
+ // "flatPath": "v1/projects/{projectsId}/operations/{operationsId}",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.operations.get",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "name": {
+ // "description": "The name of the operation resource.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+/operations/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "GoogleLongrunning__Operation"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// method id "ml.projects.operations.list":
+
+type ProjectsOperationsListCall struct {
+ s *Service
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: 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 below allows API services to override the
+// binding
+// to use different resource name schemes, such as `users/*/operations`.
+func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall {
+ c := &ProjectsOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Filter sets the optional parameter "filter": The standard list
+// filter.
+func (c *ProjectsOperationsListCall) Filter(filter string) *ProjectsOperationsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The standard list
+// page size.
+func (c *ProjectsOperationsListCall) PageSize(pageSize int64) *ProjectsOperationsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The standard list
+// page token.
+func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperationsListCall {
+ 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 *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall {
+ 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 *ProjectsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsOperationsListCall {
+ 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 *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall {
+ 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 *ProjectsOperationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ProjectsOperationsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+name}/operations")
+ 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 "ml.projects.operations.list" call.
+// Exactly one of *GoogleLongrunning__ListOperationsResponse or error
+// will be non-nil. Any non-2xx status code is an error. Response
+// headers are in either
+// *GoogleLongrunning__ListOperationsResponse.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 *ProjectsOperationsListCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunning__ListOperationsResponse, 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 := &GoogleLongrunning__ListOperationsResponse{
+ 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 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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ // "flatPath": "v1/projects/{projectsId}/operations",
+ // "httpMethod": "GET",
+ // "id": "ml.projects.operations.list",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "The standard list filter.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name of the operation collection.",
+ // "location": "path",
+ // "pattern": "^projects/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The standard list page size.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "The standard list page token.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}/operations",
+ // "response": {
+ // "$ref": "GoogleLongrunning__ListOperationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform"
+ // ]
+ // }
+
+}
+
+// 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 *ProjectsOperationsListCall) Pages(ctx context.Context, f func(*GoogleLongrunning__ListOperationsResponse) 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/ml/v1beta1/ml-api.json b/ml/v1beta1/ml-api.json
index abb2393..92fa1db 100644
--- a/ml/v1beta1/ml-api.json
+++ b/ml/v1beta1/ml-api.json
@@ -1,4 +1,6 @@
{
+ "ownerDomain": "google.com",
+ "name": "ml",
"batchPath": "batch",
"title": "Google Cloud Machine Learning Engine",
"ownerName": "Google",
@@ -6,8 +8,6 @@
"projects": {
"methods": {
"predict": {
- "path": "v1beta1/{+name}:predict",
- "id": "ml.projects.predict",
"request": {
"$ref": "GoogleCloudMlV1beta1__PredictRequest"
},
@@ -31,77 +31,47 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectsId}:predict"
+ "flatPath": "v1beta1/projects/{projectsId}:predict",
+ "path": "v1beta1/{+name}:predict",
+ "id": "ml.projects.predict"
},
"getConfig": {
- "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
- "response": {
- "$ref": "GoogleCloudMlV1beta1__GetConfigResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
- "location": "path",
"description": "Required. The project name.\n\nAuthorization: requires `Viewer` role on the specified project.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+$"
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1beta1/projects/{projectsId}:getConfig",
"path": "v1beta1/{+name}:getConfig",
- "id": "ml.projects.getConfig"
+ "id": "ml.projects.getConfig",
+ "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__GetConfigResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ]
}
},
"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": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "delete": {
"parameters": {
"name": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"location": "path",
- "description": "The name of the operation resource to be cancelled."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel",
- "path": "v1beta1/{+name}:cancel",
- "id": "ml.projects.operations.cancel"
- },
- "delete": {
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
"description": "The name of the operation resource to be deleted.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path"
+ "type": "string"
}
},
"scopes": [
@@ -110,22 +80,28 @@
"flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
"path": "v1beta1/{+name}",
"id": "ml.projects.operations.delete",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "list": {
+ "description": "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": "GoogleProtobuf__Empty"
+ },
"parameterOrder": [
"name"
],
- "httpMethod": "GET",
+ "httpMethod": "DELETE"
+ },
+ "list": {
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "parameterOrder": [
+ "name"
+ ],
"response": {
"$ref": "GoogleLongrunning__ListOperationsResponse"
},
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"parameters": {
- "filter": {
- "type": "string",
- "location": "query",
- "description": "The standard list filter."
- },
"name": {
"description": "The name of the operation collection.",
"required": true,
@@ -139,97 +115,79 @@
"type": "string"
},
"pageSize": {
- "location": "query",
"description": "The standard list page size.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/operations",
+ "id": "ml.projects.operations.list",
+ "path": "v1beta1/{+name}/operations"
+ },
+ "get": {
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/operations/[^/]+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
- "flatPath": "v1beta1/projects/{projectsId}/operations",
- "id": "ml.projects.operations.list",
- "path": "v1beta1/{+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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`."
- },
- "get": {
+ "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
+ "path": "v1beta1/{+name}",
+ "id": "ml.projects.operations.get",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
"response": {
"$ref": "GoogleLongrunning__Operation"
},
"httpMethod": "GET",
"parameterOrder": [
"name"
- ],
+ ]
+ },
+ "cancel": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
+ "description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource."
+ "location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel",
+ "id": "ml.projects.operations.cancel",
+ "path": "v1beta1/{+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": "GoogleProtobuf__Empty"
+ }
}
}
},
"models": {
"methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
+ "create": {
"parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}",
- "id": "ml.projects.models.delete",
- "path": "v1beta1/{+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/reference/rest/v1beta1/projects.models.versions/delete)."
- },
- "list": {
- "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.",
- "response": {
- "$ref": "GoogleCloudMlV1beta1__ListModelsResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
"parent": {
- "description": "Required. The name of the project whose models are to be listed.\n\nAuthorization: requires `Viewer` role on the specified project.",
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+$",
@@ -240,152 +198,110 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/projects/{projectsId}/models",
- "path": "v1beta1/{+parent}/models",
- "id": "ml.projects.models.list"
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path",
- "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project."
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.models.get",
- "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed)."
- },
- "create": {
- "flatPath": "v1beta1/projects/{projectsId}/models",
- "path": "v1beta1/{+parent}/models",
"id": "ml.projects.models.create",
+ "path": "v1beta1/{+parent}/models",
"request": {
"$ref": "GoogleCloudMlV1beta1__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/reference/rest/v1beta1/projects.models.versions/create).",
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Model"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"parent"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ }
+ },
+ "delete": {
"parameters": {
+ "name": {
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}",
+ "id": "ml.projects.models.delete",
+ "path": "v1beta1/{+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/reference/rest/v1beta1/projects.models.versions/delete).",
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
+ }
+ },
+ "list": {
+ "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.",
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__ListModelsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer"
+ },
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
- "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ "description": "Required. The name of the project whose models are to be listed.\n\nAuthorization: requires `Viewer` role on the specified project.",
"required": true,
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/models",
+ "path": "v1beta1/{+parent}/models",
+ "id": "ml.projects.models.list"
+ },
+ "get": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the model.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}",
+ "path": "v1beta1/{+name}",
+ "id": "ml.projects.models.get",
+ "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Model"
+ },
+ "httpMethod": "GET"
}
},
"resources": {
"versions": {
"methods": {
- "delete": {
- "id": "ml.projects.models.versions.delete",
- "path": "v1beta1/{+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.",
- "httpMethod": "DELETE",
- "response": {
- "$ref": "GoogleLongrunning__Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the version. You can get the names of all the\nversions of a model by calling\n[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}"
- },
- "list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__ListVersionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "pageSize": {
- "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the model for which to list the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions",
- "id": "ml.projects.models.versions.list",
- "path": "v1beta1/{+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):"
- },
- "get": {
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Version"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
- "path": "v1beta1/{+name}",
- "id": "ml.projects.models.versions.get",
- "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model."
- },
"create": {
"description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml/reference/rest/v1beta1/projects.models.versions/setDefault).",
"request": {
@@ -415,32 +331,118 @@
"path": "v1beta1/{+parent}/versions"
},
"setDefault": {
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
+ "id": "ml.projects.models.versions.setDefault",
+ "path": "v1beta1/{+name}:setDefault",
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__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": "GoogleCloudMlV1beta1__Version"
+ }
+ },
+ "delete": {
+ "response": {
+ "$ref": "GoogleLongrunning__Operation"
},
"parameterOrder": [
"name"
],
- "httpMethod": "POST",
+ "httpMethod": "DELETE",
"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/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
+ "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/reference/rest/v1beta1/projects.models.versions/list).\n\nAuthorization: requires `Editor` role on the parent project.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault",
- "path": "v1beta1/{+name}:setDefault",
- "id": "ml.projects.models.versions.setDefault",
- "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method.",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__SetDefaultVersionRequest"
- }
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1beta1/{+name}",
+ "id": "ml.projects.models.versions.delete",
+ "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version."
+ },
+ "list": {
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__ListVersionsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the model for which to list the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions",
+ "path": "v1beta1/{+parent}/versions",
+ "id": "ml.projects.models.versions.list",
+ "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has a lot of versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages):"
+ },
+ "get": {
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Version"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the version.\n\nAuthorization: requires `Viewer` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}",
+ "path": "v1beta1/{+name}",
+ "id": "ml.projects.models.versions.get",
+ "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml/reference/rest/v1beta1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model."
}
}
}
@@ -448,63 +450,8 @@
},
"jobs": {
"methods": {
- "create": {
- "description": "Creates a training or a batch prediction job.",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__Job"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "GoogleCloudMlV1beta1__Job"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/jobs",
- "id": "ml.projects.jobs.create",
- "path": "v1beta1/{+parent}/jobs"
- },
- "cancel": {
- "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}:cancel",
- "id": "ml.projects.jobs.cancel",
- "path": "v1beta1/{+name}:cancel",
- "description": "Cancels a running job.",
- "request": {
- "$ref": "GoogleCloudMlV1beta1__CancelJobRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "GoogleProtobuf__Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the job to cancel.\n\nAuthorization: requires `Editor` role on the parent project.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$",
- "location": "path"
- }
- }
- },
"list": {
+ "description": "Lists the jobs in the project.",
"httpMethod": "GET",
"response": {
"$ref": "GoogleCloudMlV1beta1__ListJobsResponse"
@@ -512,9 +459,6 @@
"parameterOrder": [
"parent"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
"parameters": {
"pageToken": {
"location": "query",
@@ -522,53 +466,111 @@
"type": "string"
},
"pageSize": {
+ "location": "query",
"description": "Optional. The number of jobs to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.",
"format": "int32",
- "type": "integer",
- "location": "query"
+ "type": "integer"
},
"parent": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
"description": "Required. The name of the project for which to list jobs.\n\nAuthorization: requires `Viewer` role on the specified project.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
},
"filter": {
- "location": "query",
"description": "Optional. Specifies the subset of jobs to retrieve.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/jobs",
"id": "ml.projects.jobs.list",
- "path": "v1beta1/{+parent}/jobs",
- "description": "Lists the jobs in the project."
+ "path": "v1beta1/{+parent}/jobs"
},
"get": {
- "description": "Describes a job.",
- "httpMethod": "GET",
"response": {
"$ref": "GoogleCloudMlV1beta1__Job"
},
"parameterOrder": [
"name"
],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
+ "httpMethod": "GET",
"parameters": {
"name": {
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
"location": "path",
"description": "Required. The name of the job to get the description of.\n\nAuthorization: requires `Viewer` role on the parent project.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/jobs/[^/]+$"
+ "type": "string"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}",
+ "path": "v1beta1/{+name}",
"id": "ml.projects.jobs.get",
- "path": "v1beta1/{+name}"
+ "description": "Describes a job."
+ },
+ "create": {
+ "parameters": {
+ "parent": {
+ "description": "Required. The project name.\n\nAuthorization: requires `Editor` role on the specified project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/jobs",
+ "id": "ml.projects.jobs.create",
+ "path": "v1beta1/{+parent}/jobs",
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__Job"
+ },
+ "description": "Creates a training or a batch prediction job.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "GoogleCloudMlV1beta1__Job"
+ }
+ },
+ "cancel": {
+ "request": {
+ "$ref": "GoogleCloudMlV1beta1__CancelJobRequest"
+ },
+ "description": "Cancels a running job.",
+ "response": {
+ "$ref": "GoogleProtobuf__Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the job to cancel.\n\nAuthorization: requires `Editor` role on the parent project.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/jobs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/jobs/{jobsId}:cancel",
+ "path": "v1beta1/{+name}:cancel",
+ "id": "ml.projects.jobs.cancel"
}
}
}
@@ -576,16 +578,6 @@
}
},
"parameters": {
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "type": "string",
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
- },
"quotaUser": {
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -603,9 +595,9 @@
"type": "string"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
@@ -613,54 +605,64 @@
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
+ "default": "true",
+ "location": "query"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
- ]
- },
- "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",
+ "enum": [
+ "1",
+ "2"
+ ]
+ },
+ "alt": {
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "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": "v1beta1",
@@ -670,11 +672,214 @@
"servicePath": "",
"basePath": "",
"revision": "20170304",
- "id": "ml:v1beta1",
"documentationLink": "https://cloud.google.com/ml/",
+ "id": "ml:v1beta1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "GoogleCloudMlV1beta1__Job": {
+ "description": "Represents a training or prediction job.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "Output only. When the job processing was started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "predictionOutput": {
+ "$ref": "GoogleCloudMlV1beta1__PredictionOutput",
+ "description": "The current prediction job result."
+ },
+ "trainingOutput": {
+ "description": "The current training job result.",
+ "$ref": "GoogleCloudMlV1beta1__TrainingOutput"
+ },
+ "createTime": {
+ "description": "Output only. When the job was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "trainingInput": {
+ "description": "Input parameters to create a training job.",
+ "$ref": "GoogleCloudMlV1beta1__TrainingInput"
+ },
+ "state": {
+ "description": "Output only. The detailed state of a job.",
+ "type": "string",
+ "enumDescriptions": [
+ "The job state is unspecified.",
+ "The job has been just created and processing has not yet begun.",
+ "The service is preparing to run the job.",
+ "The job is in progress.",
+ "The job completed successfully.",
+ "The job failed.\n`error_message` should contain the details of the failure.",
+ "The job is being cancelled.\n`error_message` should describe the reason for the cancellation.",
+ "The job has been cancelled.\n`error_message` should describe the reason for the cancellation."
+ ],
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "QUEUED",
+ "PREPARING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLING",
+ "CANCELLED"
+ ]
+ },
+ "predictionInput": {
+ "description": "Input parameters to create a prediction job.",
+ "$ref": "GoogleCloudMlV1beta1__PredictionInput"
+ },
+ "jobId": {
+ "description": "Required. The user-specified id of the job.",
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Output only. The details of a failure or a cancellation.",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "Output only. When the job processing was completed.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__Job"
+ },
+ "GoogleCloudMlV1beta1__TrainingInput": {
+ "description": "Represents input parameters for a training job.",
+ "type": "object",
+ "properties": {
+ "workerCount": {
+ "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "masterType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"ml/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\"\u003ecoplex_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"
+ },
+ "pythonModule": {
+ "description": "Required. The Python module name to run after installing the packages.",
+ "type": "string"
+ },
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the training job in.",
+ "type": "string"
+ },
+ "args": {
+ "description": "Optional. Command line arguments to pass to the program.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "workerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.",
+ "type": "string"
+ },
+ "parameterServerType": {
+ "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
+ "type": "string"
+ },
+ "scaleTier": {
+ "enumDescriptions": [
+ "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.",
+ "Many workers and a few parameter servers.",
+ "A large number of workers with many parameter servers.",
+ "A single worker instance [with a GPU](ml/docs/how-tos/using-gpus).",
+ "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type."
+ ],
+ "enum": [
+ "BASIC",
+ "STANDARD_1",
+ "PREMIUM_1",
+ "BASIC_GPU",
+ "CUSTOM"
+ ],
+ "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
+ "type": "string"
+ },
+ "jobDir": {
+ "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
+ "type": "string"
+ },
+ "hyperparameters": {
+ "description": "Optional. The set of Hyperparameters to tune.",
+ "$ref": "GoogleCloudMlV1beta1__HyperparameterSpec"
+ },
+ "parameterServerCount": {
+ "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "packageUris": {
+ "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GoogleCloudMlV1beta1__TrainingInput"
+ },
+ "GoogleLongrunning__ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
+ "type": "object",
+ "properties": {
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleLongrunning__Operation"
+ }
+ },
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
+ "type": "string"
+ }
+ },
+ "id": "GoogleLongrunning__ListOperationsResponse"
+ },
+ "GoogleCloudMlV1beta1__GetConfigResponse": {
+ "id": "GoogleCloudMlV1beta1__GetConfigResponse",
+ "description": "Returns service account information associated with a project.",
+ "type": "object",
+ "properties": {
+ "serviceAccountProject": {
+ "description": "The project number for `service_account`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "serviceAccount": {
+ "description": "The service account Cloud ML uses to access resources in the project.",
+ "type": "string"
+ }
+ }
+ },
+ "GoogleCloudMlV1beta1__SetDefaultVersionRequest": {
+ "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest",
+ "description": "Request message for the SetDefaultVersion request.",
+ "type": "object",
+ "properties": {}
+ },
+ "GoogleCloudMlV1__ManualScaling": {
+ "description": "Options for manually scaling a model.",
+ "type": "object",
+ "properties": {
+ "nodes": {
+ "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to nodes * number of hours since\ndeployment.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GoogleCloudMlV1__ManualScaling"
+ },
"GoogleCloudMlV1beta1__ParameterSpec": {
"description": "Represents a single hyperparameter to optimize.",
"type": "object",
@@ -714,6 +919,13 @@
"type": "number"
},
"type": {
+ "enumDescriptions": [
+ "You must specify a valid type. Using this unspecified type will result in\nan error.",
+ "Type for real-valued parameters.",
+ "Type for integral parameters.",
+ "The parameter is categorical, with a value chosen from the categories\nfield.",
+ "The parameter is real valued, with a fixed set of feasible points. If\n`type==DISCRETE`, feasible_points must be provided, and\n{`min_value`, `max_value`} will be ignored."
+ ],
"enum": [
"PARAMETER_TYPE_UNSPECIFIED",
"DOUBLE",
@@ -722,21 +934,14 @@
"DISCRETE"
],
"description": "Required. The type of the parameter.",
- "type": "string",
- "enumDescriptions": [
- "You must specify a valid type. Using this unspecified type will result in\nan error.",
- "Type for real-valued parameters.",
- "Type for integral parameters.",
- "The parameter is categorical, with a value chosen from the categories\nfield.",
- "The parameter is real valued, with a fixed set of feasible points. If\n`type==DISCRETE`, feasible_points must be provided, and\n{`min_value`, `max_value`} will be ignored."
- ]
+ "type": "string"
},
"categoricalValues": {
+ "description": "Required if type is `CATEGORICAL`. The list of possible categories.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "Required if type is `CATEGORICAL`. The list of possible categories."
+ }
},
"parameterName": {
"description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".",
@@ -746,6 +951,7 @@
"id": "GoogleCloudMlV1beta1__ParameterSpec"
},
"GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric": {
+ "id": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric",
"description": "An observed value of a metric.",
"type": "object",
"properties": {
@@ -759,8 +965,7 @@
"format": "double",
"type": "number"
}
- },
- "id": "GoogleCloudMlV1beta1_HyperparameterOutput_HyperparameterMetric"
+ }
},
"GoogleCloudMlV1beta1__PredictionOutput": {
"description": "Represents results of a prediction job.",
@@ -776,9 +981,9 @@
"type": "string"
},
"nodeHours": {
- "type": "number",
"description": "Node hours used by the batch prediction job.",
- "format": "double"
+ "format": "double",
+ "type": "number"
},
"predictionCount": {
"description": "The number of generated predictions.",
@@ -789,15 +994,10 @@
"id": "GoogleCloudMlV1beta1__PredictionOutput"
},
"GoogleCloudMlV1beta1__TrainingOutput": {
+ "id": "GoogleCloudMlV1beta1__TrainingOutput",
+ "description": "Represents results of a training job. Output only.",
"type": "object",
"properties": {
- "trials": {
- "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
- "type": "array",
- "items": {
- "$ref": "GoogleCloudMlV1beta1__HyperparameterOutput"
- }
- },
"completedTrialCount": {
"description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.",
"format": "int64",
@@ -811,22 +1011,29 @@
"description": "The amount of ML units consumed by the job.",
"format": "double",
"type": "number"
+ },
+ "trials": {
+ "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.",
+ "type": "array",
+ "items": {
+ "$ref": "GoogleCloudMlV1beta1__HyperparameterOutput"
+ }
}
- },
- "id": "GoogleCloudMlV1beta1__TrainingOutput",
- "description": "Represents results of a training job. Output only."
+ }
},
"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/reference/rest/v1/projects.models.versions/list).",
+ "type": "object",
"properties": {
+ "runtimeVersion": {
+ "description": "Optional. The Google Cloud ML runtime version to use for this deployment.\nIf not set, Google Cloud ML will choose a version.",
+ "type": "string"
+ },
"lastUseTime": {
"description": "Output only. The time the version was last used for prediction.",
"format": "google-datetime",
"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"
@@ -853,14 +1060,31 @@
"type": "string"
}
},
- "id": "GoogleCloudMlV1__Version",
- "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml/reference/rest/v1/projects.models.versions/list).",
- "type": "object"
+ "id": "GoogleCloudMlV1__Version"
},
"GoogleCloudMlV1beta1__HyperparameterSpec": {
+ "id": "GoogleCloudMlV1beta1__HyperparameterSpec",
"description": "Represents a set of hyperparameters to optimize.",
"type": "object",
"properties": {
+ "goal": {
+ "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.",
+ "type": "string",
+ "enumDescriptions": [
+ "Goal Type will default to maximize.",
+ "Maximize the goal metric.",
+ "Minimize the goal metric."
+ ],
+ "enum": [
+ "GOAL_TYPE_UNSPECIFIED",
+ "MAXIMIZE",
+ "MINIMIZE"
+ ]
+ },
+ "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"
+ },
"params": {
"description": "Required. The set of parameters to tune.",
"type": "array",
@@ -877,45 +1101,13 @@
"description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.",
"format": "int32",
"type": "integer"
- },
- "goal": {
- "enumDescriptions": [
- "Goal Type will default to maximize.",
- "Maximize the goal metric.",
- "Minimize the goal metric."
- ],
- "enum": [
- "GOAL_TYPE_UNSPECIFIED",
- "MAXIMIZE",
- "MINIMIZE"
- ],
- "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.",
- "type": "string"
- },
- "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"
}
- },
- "id": "GoogleCloudMlV1beta1__HyperparameterSpec"
+ }
},
"GoogleCloudMlV1__OperationMetadata": {
+ "description": "Represents the metadata of the long-running operation.",
"type": "object",
"properties": {
- "startTime": {
- "description": "The time operation processing started.",
- "format": "google-datetime",
- "type": "string"
- },
- "isCancellationRequested": {
- "type": "boolean",
- "description": "Indicates whether a request to cancel this operation has been made."
- },
- "createTime": {
- "description": "The time the operation was submitted.",
- "format": "google-datetime",
- "type": "string"
- },
"modelName": {
"description": "Contains the name of the model associated with the operation.",
"type": "string"
@@ -930,6 +1122,12 @@
"type": "string"
},
"operationType": {
+ "enumDescriptions": [
+ "Unspecified operation type.",
+ "An operation to create a new version.",
+ "An operation to delete an existing version.",
+ "An operation to delete an existing model."
+ ],
"enum": [
"OPERATION_TYPE_UNSPECIFIED",
"CREATE_VERSION",
@@ -937,17 +1135,24 @@
"DELETE_MODEL"
],
"description": "The operation type.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified operation type.",
- "An operation to create a new version.",
- "An operation to delete an existing version.",
- "An operation to delete an existing model."
- ]
+ "type": "string"
+ },
+ "startTime": {
+ "description": "The time operation processing started.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "isCancellationRequested": {
+ "description": "Indicates whether a request to cancel this operation has been made.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "The time the operation was submitted.",
+ "format": "google-datetime",
+ "type": "string"
}
},
- "id": "GoogleCloudMlV1__OperationMetadata",
- "description": "Represents the metadata of the long-running operation."
+ "id": "GoogleCloudMlV1__OperationMetadata"
},
"GoogleCloudMlV1beta1__OperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
@@ -958,8 +1163,8 @@
"type": "string"
},
"version": {
- "description": "Contains the version associated with the operation.",
- "$ref": "GoogleCloudMlV1beta1__Version"
+ "$ref": "GoogleCloudMlV1beta1__Version",
+ "description": "Contains the version associated with the operation."
},
"endTime": {
"description": "The time operation processing completed.",
@@ -1000,39 +1205,28 @@
"id": "GoogleCloudMlV1beta1__OperationMetadata"
},
"GoogleCloudMlV1beta1__ListModelsResponse": {
+ "id": "GoogleCloudMlV1beta1__ListModelsResponse",
"description": "Response message for the ListModels method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
"models": {
+ "description": "The list of models.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1beta1__Model"
- },
- "description": "The list of models."
+ }
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
}
- },
- "id": "GoogleCloudMlV1beta1__ListModelsResponse"
+ }
},
"GoogleLongrunning__Operation": {
+ "id": "GoogleLongrunning__Operation",
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "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": {
- "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"
@@ -1048,15 +1242,36 @@
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
}
- },
- "id": "GoogleLongrunning__Operation"
+ }
},
"GoogleCloudMlV1beta1__HyperparameterOutput": {
- "id": "GoogleCloudMlV1beta1__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.",
"type": "array",
@@ -1067,28 +1282,17 @@
"finalMetric": {
"description": "The final objective metric seen for this trial.",
"$ref": "GoogleCloudMlV1beta1_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": "GoogleCloudMlV1beta1__HyperparameterOutput"
},
"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",
- "properties": {},
- "id": "GoogleProtobuf__Empty"
+ "properties": {}
},
"GoogleCloudMlV1beta1__ManualScaling": {
- "id": "GoogleCloudMlV1beta1__ManualScaling",
"description": "Options for manually scaling a model.",
"type": "object",
"properties": {
@@ -1097,17 +1301,13 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "GoogleCloudMlV1beta1__ManualScaling"
},
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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"
@@ -1122,41 +1322,50 @@
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
}
},
"id": "GoogleRpc__Status"
},
"GoogleCloudMlV1beta1__PredictRequest": {
+ "description": "Request for predictions to be issued against a trained model.\n\nThe body of the request is a single JSON object with a single top-level\nfield:\n\n\u003cdl\u003e\n \u003cdt\u003einstances\u003c/dt\u003e\n \u003cdd\u003eA JSON array containing values representing the instances to use for\n prediction.\u003c/dd\u003e\n\u003c/dl\u003e\n\nThe structure of each element of the instances list is determined by your\nmodel's input definition. Instances can include named inputs or can contain\nonly unlabeled values.\n\nNot all data includes named inputs. Some instances will be simple\nJSON values (boolean, number, or string). However, instances are often lists\nof simple values, or complex nested lists. Here are some examples of request\nbodies:\n\nCSV data with each row encoded as a string value:\n\u003cpre\u003e\n{\"instances\": [\"1.0,true,\\\\\"x\\\\\"\", \"-2.0,false,\\\\\"y\\\\\"\"]}\n\u003c/pre\u003e\nPlain text:\n\u003cpre\u003e\n{\"instances\": [\"the quick brown fox\", \"la bruja le dio\"]}\n\u003c/pre\u003e\nSentences encoded as lists of words (vectors of strings):\n\u003cpre\u003e\n{\n \"instances\": [\n [\"the\",\"quick\",\"brown\"],\n [\"la\",\"bruja\",\"le\"],\n ...\n ]\n}\n\u003c/pre\u003e\nFloating point scalar values:\n\u003cpre\u003e\n{\"instances\": [0.0, 1.1, 2.2]}\n\u003c/pre\u003e\nVectors of integers:\n\u003cpre\u003e\n{\n \"instances\": [\n [0, 1, 2],\n [3, 4, 5],\n ...\n ]\n}\n\u003c/pre\u003e\nTensors (in this case, two-dimensional tensors):\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [0, 1, 2],\n [3, 4, 5]\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nImages can be represented different ways. In this encoding scheme the first\ntwo dimensions represent the rows and columns of the image, and the third\ncontains lists (vectors) of the R, G, and B values for each pixel.\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nJSON strings must be encoded as UTF-8. To send binary data, you must\nbase64-encode the data and mark it as binary. To mark a JSON string\nas binary, replace it with a JSON object with a single attribute named `b64`:\n\u003cpre\u003e{\"b64\": \"...\"} \u003c/pre\u003e\nFor example:\n\nTwo Serialized tf.Examples (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"X5ad6u\"}, {\"b64\": \"IA9j4nx\"}]}\n\u003c/pre\u003e\nTwo JPEG image byte strings (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"ASa8asdf\"}, {\"b64\": \"JLK7ljk3\"}]}\n\u003c/pre\u003e\nIf your data includes named references, format each instance as a JSON object\nwith the named references as the keys:\n\nJSON input data to be preprocessed:\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"a\": 1.0,\n \"b\": true,\n \"c\": \"x\"\n },\n {\n \"a\": -2.0,\n \"b\": false,\n \"c\": \"y\"\n }\n ]\n}\n\u003c/pre\u003e\nSome models have an underlying TensorFlow graph that accepts multiple input\ntensors. In this case, you should use the names of JSON name/value pairs to\nidentify the input tensors, as shown in the following exmaples:\n\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(base64-encoded string):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": {\"b64\": \"ASa8asdf\"}\n },\n {\n \"tag\": \"car\",\n \"image\": {\"b64\": \"JLK7ljk3\"}\n }\n ]\n}\n\u003c/pre\u003e\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(3-dimensional array of 8-bit ints):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ]\n },\n {\n \"tag\": \"car\",\n \"image\": [\n [\n [255, 0, 102],\n [255, 0, 97],\n ...\n ],\n [\n [254, 1, 101],\n [254, 2, 93],\n ...\n ],\n ...\n ]\n },\n ...\n ]\n}\n\u003c/pre\u003e\nIf the call is successful, the response body will contain one prediction\nentry per instance in the request body. If prediction fails for any\ninstance, the response body will contain no predictions and will contian\na single error entry instead.",
"type": "object",
"properties": {
"httpBody": {
- "$ref": "GoogleApi__HttpBody",
- "description": "\nRequired. The prediction request body."
+ "description": "\nRequired. The prediction request body.",
+ "$ref": "GoogleApi__HttpBody"
}
},
- "id": "GoogleCloudMlV1beta1__PredictRequest",
- "description": "Request for predictions to be issued against a trained model.\n\nThe body of the request is a single JSON object with a single top-level\nfield:\n\n\u003cdl\u003e\n \u003cdt\u003einstances\u003c/dt\u003e\n \u003cdd\u003eA JSON array containing values representing the instances to use for\n prediction.\u003c/dd\u003e\n\u003c/dl\u003e\n\nThe structure of each element of the instances list is determined by your\nmodel's input definition. Instances can include named inputs or can contain\nonly unlabeled values.\n\nNot all data includes named inputs. Some instances will be simple\nJSON values (boolean, number, or string). However, instances are often lists\nof simple values, or complex nested lists. Here are some examples of request\nbodies:\n\nCSV data with each row encoded as a string value:\n\u003cpre\u003e\n{\"instances\": [\"1.0,true,\\\\\"x\\\\\"\", \"-2.0,false,\\\\\"y\\\\\"\"]}\n\u003c/pre\u003e\nPlain text:\n\u003cpre\u003e\n{\"instances\": [\"the quick brown fox\", \"la bruja le dio\"]}\n\u003c/pre\u003e\nSentences encoded as lists of words (vectors of strings):\n\u003cpre\u003e\n{\n \"instances\": [\n [\"the\",\"quick\",\"brown\"],\n [\"la\",\"bruja\",\"le\"],\n ...\n ]\n}\n\u003c/pre\u003e\nFloating point scalar values:\n\u003cpre\u003e\n{\"instances\": [0.0, 1.1, 2.2]}\n\u003c/pre\u003e\nVectors of integers:\n\u003cpre\u003e\n{\n \"instances\": [\n [0, 1, 2],\n [3, 4, 5],\n ...\n ]\n}\n\u003c/pre\u003e\nTensors (in this case, two-dimensional tensors):\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [0, 1, 2],\n [3, 4, 5]\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nImages can be represented different ways. In this encoding scheme the first\ntwo dimensions represent the rows and columns of the image, and the third\ncontains lists (vectors) of the R, G, and B values for each pixel.\n\u003cpre\u003e\n{\n \"instances\": [\n [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ],\n ...\n ]\n}\n\u003c/pre\u003e\nJSON strings must be encoded as UTF-8. To send binary data, you must\nbase64-encode the data and mark it as binary. To mark a JSON string\nas binary, replace it with a JSON object with a single attribute named `b64`:\n\u003cpre\u003e{\"b64\": \"...\"} \u003c/pre\u003e\nFor example:\n\nTwo Serialized tf.Examples (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"X5ad6u\"}, {\"b64\": \"IA9j4nx\"}]}\n\u003c/pre\u003e\nTwo JPEG image byte strings (fake data, for illustrative purposes only):\n\u003cpre\u003e\n{\"instances\": [{\"b64\": \"ASa8asdf\"}, {\"b64\": \"JLK7ljk3\"}]}\n\u003c/pre\u003e\nIf your data includes named references, format each instance as a JSON object\nwith the named references as the keys:\n\nJSON input data to be preprocessed:\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"a\": 1.0,\n \"b\": true,\n \"c\": \"x\"\n },\n {\n \"a\": -2.0,\n \"b\": false,\n \"c\": \"y\"\n }\n ]\n}\n\u003c/pre\u003e\nSome models have an underlying TensorFlow graph that accepts multiple input\ntensors. In this case, you should use the names of JSON name/value pairs to\nidentify the input tensors, as shown in the following exmaples:\n\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(base64-encoded string):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": {\"b64\": \"ASa8asdf\"}\n },\n {\n \"tag\": \"car\",\n \"image\": {\"b64\": \"JLK7ljk3\"}\n }\n ]\n}\n\u003c/pre\u003e\nFor a graph with input tensor aliases \"tag\" (string) and \"image\"\n(3-dimensional array of 8-bit ints):\n\u003cpre\u003e\n{\n \"instances\": [\n {\n \"tag\": \"beach\",\n \"image\": [\n [\n [138, 30, 66],\n [130, 20, 56],\n ...\n ],\n [\n [126, 38, 61],\n [122, 24, 57],\n ...\n ],\n ...\n ]\n },\n {\n \"tag\": \"car\",\n \"image\": [\n [\n [255, 0, 102],\n [255, 0, 97],\n ...\n ],\n [\n [254, 1, 101],\n [254, 2, 93],\n ...\n ],\n ...\n ]\n },\n ...\n ]\n}\n\u003c/pre\u003e\nIf the call is successful, the response body will contain one prediction\nentry per instance in the request body. If prediction fails for any\ninstance, the response body will contain no predictions and will contian\na single error entry instead."
- },
- "GoogleApi__HttpBody": {
- "id": "GoogleApi__HttpBody",
- "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
- "type": "object",
- "properties": {
- "data": {
- "description": "HTTP body binary data.",
- "format": "byte",
- "type": "string"
- },
- "contentType": {
- "description": "The HTTP Content-Type string representing the content type of the body.",
- "type": "string"
- }
- }
+ "id": "GoogleCloudMlV1beta1__PredictRequest"
},
"GoogleCloudMlV1beta1__PredictionInput": {
+ "id": "GoogleCloudMlV1beta1__PredictionInput",
"description": "Represents input parameters for a prediction job.",
"type": "object",
"properties": {
+ "inputPaths": {
+ "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "region": {
+ "description": "Required. The Google Compute Engine region to run the prediction job in.",
+ "type": "string"
+ },
+ "versionName": {
+ "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`",
+ "type": "string"
+ },
+ "modelName": {
+ "description": "Use this field if you want to use the default version for the specified\nmodel. The string must use the following format:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003e[YOUR_MODEL]\u003c/var\u003e\"`",
+ "type": "string"
+ },
"outputPath": {
"description": "Required. The output Google Cloud Storage location.",
"type": "string"
@@ -1189,51 +1398,60 @@
"runtimeVersion": {
"description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.",
"type": "string"
- },
- "inputPaths": {
- "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the prediction job in.",
- "type": "string"
- },
- "versionName": {
- "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`",
- "type": "string"
- },
- "modelName": {
- "type": "string",
- "description": "Use this field if you want to use the default version for the specified\nmodel. The string must use the following format:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003e[YOUR_MODEL]\u003c/var\u003e\"`"
}
- },
- "id": "GoogleCloudMlV1beta1__PredictionInput"
+ }
+ },
+ "GoogleApi__HttpBody": {
+ "id": "GoogleApi__HttpBody",
+ "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.",
+ "type": "object",
+ "properties": {
+ "contentType": {
+ "description": "The HTTP Content-Type string representing the content type of the body.",
+ "type": "string"
+ },
+ "data": {
+ "description": "HTTP body binary data.",
+ "format": "byte",
+ "type": "string"
+ }
+ }
},
"GoogleCloudMlV1beta1__ListJobsResponse": {
- "id": "GoogleCloudMlV1beta1__ListJobsResponse",
"description": "Response message for the ListJobs method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
- "type": "string"
- },
"jobs": {
"description": "The list of jobs.",
"type": "array",
"items": {
"$ref": "GoogleCloudMlV1beta1__Job"
}
+ },
+ "nextPageToken": {
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
}
- }
+ },
+ "id": "GoogleCloudMlV1beta1__ListJobsResponse"
},
"GoogleCloudMlV1beta1__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/reference/rest/v1beta1/projects.models.versions/list).",
"type": "object",
"properties": {
+ "name": {
+ "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
+ "type": "string"
+ },
+ "lastUseTime": {
+ "description": "Output only. The time the version was last used for prediction.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "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"
@@ -1243,8 +1461,8 @@
"type": "string"
},
"isDefault": {
- "type": "boolean",
- "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/reference/rest/v1beta1/projects.models.versions/setDefault)."
+ "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/reference/rest/v1beta1/projects.models.versions/setDefault).",
+ "type": "boolean"
},
"createTime": {
"description": "Output only. The time the version was created.",
@@ -1254,19 +1472,6 @@
"manualScaling": {
"$ref": "GoogleCloudMlV1beta1__ManualScaling",
"description": "Optional. Manually select the number of nodes to use for serving the\nmodel. If unset (i.e., by default), the number of nodes used to serve\nthe model automatically scales with traffic. However, care should be\ntaken to ramp up traffic according to the model's ability to scale. If\nyour model needs to handle bursts of traffic beyond it's ability to\nscale, it is recommended you set this field appropriately."
- },
- "name": {
- "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.",
- "type": "string"
- },
- "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": {
- "description": "Output only. The time the version was last used for prediction.",
- "format": "google-datetime",
- "type": "string"
}
},
"id": "GoogleCloudMlV1beta1__Version"
@@ -1283,8 +1488,8 @@
}
},
"nextPageToken": {
- "type": "string",
- "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call."
+ "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.",
+ "type": "string"
}
},
"id": "GoogleCloudMlV1beta1__ListVersionsResponse"
@@ -1299,16 +1504,9 @@
"description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.",
"type": "object",
"properties": {
- "regions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set."
- },
"name": {
- "type": "string",
- "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in."
+ "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.",
+ "type": "string"
},
"description": {
"description": "Optional. The description specified for the model when it was created.",
@@ -1319,221 +1517,25 @@
"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/reference/rest/v1beta1/projects.models.versions/setDefault).",
- "$ref": "GoogleCloudMlV1beta1__Version"
+ "$ref": "GoogleCloudMlV1beta1__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/reference/rest/v1beta1/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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
},
"id": "GoogleCloudMlV1beta1__Model"
- },
- "GoogleCloudMlV1beta1__Job": {
- "description": "Represents a training or prediction job.",
- "type": "object",
- "properties": {
- "trainingInput": {
- "$ref": "GoogleCloudMlV1beta1__TrainingInput",
- "description": "Input parameters to create a training job."
- },
- "createTime": {
- "type": "string",
- "description": "Output only. When the job was created.",
- "format": "google-datetime"
- },
- "state": {
- "description": "Output only. The detailed state of a job.",
- "type": "string",
- "enumDescriptions": [
- "The job state is unspecified.",
- "The job has been just created and processing has not yet begun.",
- "The service is preparing to run the job.",
- "The job is in progress.",
- "The job completed successfully.",
- "The job failed.\n`error_message` should contain the details of the failure.",
- "The job is being cancelled.\n`error_message` should describe the reason for the cancellation.",
- "The job has been cancelled.\n`error_message` should describe the reason for the cancellation."
- ],
- "enum": [
- "STATE_UNSPECIFIED",
- "QUEUED",
- "PREPARING",
- "RUNNING",
- "SUCCEEDED",
- "FAILED",
- "CANCELLING",
- "CANCELLED"
- ]
- },
- "predictionInput": {
- "$ref": "GoogleCloudMlV1beta1__PredictionInput",
- "description": "Input parameters to create a prediction job."
- },
- "errorMessage": {
- "description": "Output only. The details of a failure or a cancellation.",
- "type": "string"
- },
- "jobId": {
- "description": "Required. The user-specified id of the job.",
- "type": "string"
- },
- "endTime": {
- "description": "Output only. When the job processing was completed.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Output only. When the job processing was started.",
- "format": "google-datetime",
- "type": "string"
- },
- "predictionOutput": {
- "description": "The current prediction job result.",
- "$ref": "GoogleCloudMlV1beta1__PredictionOutput"
- },
- "trainingOutput": {
- "description": "The current training job result.",
- "$ref": "GoogleCloudMlV1beta1__TrainingOutput"
- }
- },
- "id": "GoogleCloudMlV1beta1__Job"
- },
- "GoogleLongrunning__ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
- "type": "object",
- "properties": {
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "GoogleLongrunning__Operation"
- }
- },
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- }
- },
- "id": "GoogleLongrunning__ListOperationsResponse"
- },
- "GoogleCloudMlV1beta1__TrainingInput": {
- "description": "Represents input parameters for a training job.",
- "type": "object",
- "properties": {
- "workerCount": {
- "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.",
- "format": "int64",
- "type": "string"
- },
- "masterType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's master worker.\n\nThe following types are supported:\n\n\u003cdl\u003e\n \u003cdt\u003estandard\u003c/dt\u003e\n \u003cdd\u003e\n A basic machine configuration suitable for training simple models with\n small to moderate datasets.\n \u003c/dd\u003e\n \u003cdt\u003elarge_model\u003c/dt\u003e\n \u003cdd\u003e\n A machine with a lot of memory, specially suited for parameter servers\n when your model is large (having many hidden layers or layers with very\n large numbers of nodes).\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_s\u003c/dt\u003e\n \u003cdd\u003e\n A machine suitable for the master and workers of the cluster when your\n model requires more computation than the standard machine can handle\n satisfactorily.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_m\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_s\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003ecomplex_model_l\u003c/dt\u003e\n \u003cdd\u003e\n A machine with roughly twice the number of cores and roughly double the\n memory of \u003ccode suppresswarning=\"true\"\u003ecomplex_model_m\u003c/code\u003e.\n \u003c/dd\u003e\n \u003cdt\u003estandard_gpu\u003c/dt\u003e\n \u003cdd\u003e\n A machine equivalent to \u003ccode suppresswarning=\"true\"\u003estandard\u003c/code\u003e that\n also includes a\n \u003ca href=\"ml/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\"\u003ecoplex_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"
- },
- "pythonModule": {
- "description": "Required. The Python module name to run after installing the packages.",
- "type": "string"
- },
- "args": {
- "description": "Optional. Command line arguments to pass to the program.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "region": {
- "description": "Required. The Google Compute Engine region to run the training job in.",
- "type": "string"
- },
- "workerType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.",
- "type": "string"
- },
- "parameterServerType": {
- "description": "Optional. Specifies the type of virtual machine to use for your training\njob's parameter server.\n\nThe supported values are the same as those described in the entry for\n`master_type`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`parameter_server_count` is greater than zero.",
- "type": "string"
- },
- "scaleTier": {
- "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.",
- "type": "string",
- "enumDescriptions": [
- "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.",
- "Many workers and a few parameter servers.",
- "A large number of workers with many parameter servers.",
- "A single worker instance [with a GPU](ml/docs/how-tos/using-gpus).",
- "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type."
- ],
- "enum": [
- "BASIC",
- "STANDARD_1",
- "PREMIUM_1",
- "BASIC_GPU",
- "CUSTOM"
- ]
- },
- "jobDir": {
- "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.",
- "type": "string"
- },
- "hyperparameters": {
- "$ref": "GoogleCloudMlV1beta1__HyperparameterSpec",
- "description": "Optional. The set of Hyperparameters to tune."
- },
- "parameterServerCount": {
- "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.",
- "format": "int64",
- "type": "string"
- },
- "packageUris": {
- "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "GoogleCloudMlV1beta1__TrainingInput"
- },
- "GoogleCloudMlV1beta1__GetConfigResponse": {
- "description": "Returns service account information associated with a project.",
- "type": "object",
- "properties": {
- "serviceAccountProject": {
- "description": "The project number for `service_account`.",
- "format": "int64",
- "type": "string"
- },
- "serviceAccount": {
- "description": "The service account Cloud ML uses to access resources in the project.",
- "type": "string"
- }
- },
- "id": "GoogleCloudMlV1beta1__GetConfigResponse"
- },
- "GoogleCloudMlV1beta1__SetDefaultVersionRequest": {
- "description": "Request message for the SetDefaultVersion request.",
- "type": "object",
- "properties": {},
- "id": "GoogleCloudMlV1beta1__SetDefaultVersionRequest"
- },
- "GoogleCloudMlV1__ManualScaling": {
- "description": "Options for manually scaling a model.",
- "type": "object",
- "properties": {
- "nodes": {
- "description": "The number of nodes to allocate for this model. These nodes are always up,\nstarting from the time the model is deployed, so the cost of operating\nthis model will be proportional to nodes * number of hours since\ndeployment.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "GoogleCloudMlV1__ManualScaling"
}
},
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
"canonicalName": "Cloud Machine Learning Engine",
"auth": {
"oauth2": {
@@ -1544,7 +1546,5 @@
}
}
},
- "rootUrl": "https://ml.googleapis.com/",
- "ownerDomain": "google.com",
- "name": "ml"
+ "rootUrl": "https://ml.googleapis.com/"
}
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json
index 6c8e4c1..f548747 100644
--- a/monitoring/v3/monitoring-api.json
+++ b/monitoring/v3/monitoring-api.json
@@ -1,615 +1,751 @@
{
- "schemas": {
- "TypedValue": {
- "description": "A single strongly-typed value.",
- "type": "object",
- "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"
- },
- "stringValue": {
- "description": "A variable-length string value.",
- "type": "string"
- }
- },
- "id": "TypedValue"
- },
- "CollectdPayload": {
- "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
- "type": "object",
- "properties": {
- "values": {
- "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
- "type": "array",
- "items": {
- "$ref": "CollectdValue"
+ "resources": {
+ "projects": {
+ "resources": {
+ "timeSeries": {
+ "methods": {
+ "list": {
+ "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "ListTimeSeriesResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "interval.startTime": {
+ "location": "query",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "view": {
+ "location": "query",
+ "enum": [
+ "FULL",
+ "HEADERS"
+ ],
+ "description": "Specifies which information is returned about the time series.",
+ "type": "string"
+ },
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\"."
+ },
+ "aggregation.groupByFields": {
+ "type": "string",
+ "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."
+ },
+ "interval.endTime": {
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "aggregation.alignmentPeriod": {
+ "location": "query",
+ "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "orderBy": {
+ "type": "string",
+ "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."
+ },
+ "aggregation.crossSeriesReducer": {
+ "location": "query",
+ "enum": [
+ "REDUCE_NONE",
+ "REDUCE_MEAN",
+ "REDUCE_MIN",
+ "REDUCE_MAX",
+ "REDUCE_SUM",
+ "REDUCE_STDDEV",
+ "REDUCE_COUNT",
+ "REDUCE_COUNT_TRUE",
+ "REDUCE_FRACTION_TRUE",
+ "REDUCE_PERCENTILE_99",
+ "REDUCE_PERCENTILE_95",
+ "REDUCE_PERCENTILE_50",
+ "REDUCE_PERCENTILE_05"
+ ],
+ "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "aggregation.perSeriesAligner": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "flatPath": "v3/projects/{projectsId}/timeSeries",
+ "path": "v3/{+name}/timeSeries",
+ "id": "monitoring.projects.timeSeries.list"
+ },
+ "create": {
+ "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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "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",
+ "id": "monitoring.projects.timeSeries.create",
+ "path": "v3/{+name}/timeSeries"
+ }
}
},
- "typeInstance": {
- "description": "The measurement type instance. Example: \"used\".",
- "type": "string"
+ "metricDescriptors": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.",
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "id": "monitoring.projects.metricDescriptors.delete",
+ "path": "v3/{+name}"
+ },
+ "list": {
+ "response": {
+ "$ref": "ListMetricDescriptorsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "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"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "path": "v3/{+name}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.list",
+ "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account."
+ },
+ "get": {
+ "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/metricDescriptors/.+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.metricDescriptors.get"
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "MetricDescriptor"
+ },
+ "parameters": {
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/metricDescriptors",
+ "id": "monitoring.projects.metricDescriptors.create",
+ "path": "v3/{+name}/metricDescriptors",
+ "request": {
+ "$ref": "MetricDescriptor"
+ },
+ "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics."
+ }
+ }
},
- "metadata": {
- "additionalProperties": {
- "$ref": "TypedValue"
+ "monitoredResourceDescriptors": {
+ "methods": {
+ "list": {
+ "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": {
+ "filter": {
+ "location": "query",
+ "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
+ "type": "string"
+ },
+ "name": {
+ "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors",
+ "path": "v3/{+name}/monitoredResourceDescriptors",
+ "id": "monitoring.projects.monitoredResourceDescriptors.list",
+ "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account."
+ },
+ "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": {
+ "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",
+ "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.monitoredResourceDescriptors.get"
+ }
+ }
+ },
+ "groups": {
+ "methods": {
+ "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": {
+ "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"
+ },
+ "name": {
+ "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ },
+ "childrenOfGroup": {
+ "location": "query",
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.",
+ "type": "string"
+ },
+ "descendantsOfGroup": {
+ "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.list",
+ "description": "Lists the existing groups."
+ },
+ "get": {
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.get",
+ "description": "Gets a single group.",
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}"
+ },
+ "update": {
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Updates an existing group. You can change any group attributes except name.",
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "name": {
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ },
+ "validateOnly": {
+ "description": "If true, validate this request but do not update the existing group.",
+ "type": "boolean",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.update"
+ },
+ "create": {
+ "response": {
+ "$ref": "Group"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "validateOnly": {
+ "type": "boolean",
+ "location": "query",
+ "description": "If true, validate this request but do not create the group."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups",
+ "path": "v3/{+name}/groups",
+ "id": "monitoring.projects.groups.create",
+ "request": {
+ "$ref": "Group"
+ },
+ "description": "Creates a new group."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring"
+ ],
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
+ "path": "v3/{+name}",
+ "id": "monitoring.projects.groups.delete",
+ "description": "Deletes an existing group."
+ }
},
- "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
- "type": "object"
+ "resources": {
+ "members": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListGroupMembersResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.read"
+ ],
+ "parameters": {
+ "interval.endTime": {
+ "location": "query",
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
+ "type": "string"
+ },
+ "interval.startTime": {
+ "location": "query",
+ "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "A positive number that is the maximum number of results to return.",
+ "format": "int32"
+ },
+ "name": {
+ "location": "path",
+ "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/groups/[^/]+$"
+ }
+ },
+ "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
+ "path": "v3/{+name}/members",
+ "id": "monitoring.projects.groups.members.list",
+ "description": "Lists the monitored resources that are members of a group."
+ }
+ }
+ }
+ }
},
- "type": {
- "description": "The measurement type. Example: \"memory\".",
- "type": "string"
- },
- "plugin": {
- "description": "The name of the plugin. Example: \"disk\".",
- "type": "string"
- },
- "pluginInstance": {
- "description": "The instance name of the plugin Example: \"hdcl\".",
- "type": "string"
- },
- "endTime": {
- "description": "The end time of the interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The start time of the interval.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "CollectdPayload"
- },
- "Linear": {
- "type": "object",
- "properties": {
- "offset": {
- "description": "Lower bound of the first bucket.",
- "format": "double",
- "type": "number"
- },
- "numFiniteBuckets": {
- "type": "integer",
- "description": "Must be greater than 0.",
- "format": "int32"
- },
- "width": {
- "description": "Must be greater than 0.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Linear",
- "description": "Specify a 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.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1))."
- },
- "Option": {
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
- "type": "object",
- "properties": {
- "value": {
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "description": "The option's value packed in an Any message. If the value is a primitive, 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"
+ "collectdTimeSeries": {
+ "methods": {
+ "create": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\"."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/monitoring",
+ "https://www.googleapis.com/auth/monitoring.write"
+ ],
+ "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
+ "path": "v3/{+name}/collectdTimeSeries",
+ "id": "monitoring.projects.collectdTimeSeries.create",
+ "request": {
+ "$ref": "CreateCollectdTimeSeriesRequest"
+ },
+ "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e"
+ }
+ }
}
}
+ }
+ },
+ "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"
},
- "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": {}
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
- "TimeInterval": {
- "properties": {
- "endTime": {
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "id": "TimeInterval",
- "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"
+ "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"
},
- "Explicit": {
- "description": "A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
- "type": "object",
- "properties": {
- "bounds": {
- "description": "The values must be monotonically increasing.",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
- }
- },
- "id": "Explicit"
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
},
- "Exponential": {
- "description": "Specify a 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.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i: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"
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
},
- "Point": {
- "description": "A single data point in a time series.",
- "type": "object",
- "properties": {
- "interval": {
- "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.",
- "$ref": "TimeInterval"
- },
- "value": {
- "$ref": "TypedValue",
- "description": "The value of the data point."
- }
- },
- "id": "Point"
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
},
- "Metric": {
- "type": "object",
- "properties": {
- "type": {
- "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
- "type": "object"
- }
- },
- "id": "Metric",
- "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor."
+ "upload_protocol": {
+ "type": "string",
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
},
- "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",
- "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"
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "oneofIndex": {
- "description": "The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "cardinality": {
- "enumDescriptions": [
- "For fields with unknown cardinality.",
- "For optional fields.",
- "For required fields. Proto2 syntax only.",
- "For repeated fields."
- ],
- "enum": [
- "CARDINALITY_UNKNOWN",
- "CARDINALITY_OPTIONAL",
- "CARDINALITY_REQUIRED",
- "CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality.",
- "type": "string"
- },
- "packed": {
- "description": "Whether to use alternative packed wire representation.",
- "type": "boolean"
- },
- "defaultValue": {
- "description": "The string value of the default value of this field. Proto2 syntax only.",
- "type": "string"
- },
- "name": {
- "description": "The field name.",
- "type": "string"
- },
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
- "type": "string"
- },
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Field"
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
- "ListTimeSeriesResponse": {
- "description": "The ListTimeSeries response.",
- "type": "object",
- "properties": {
- "timeSeries": {
- "type": "array",
- "items": {
- "$ref": "TimeSeries"
- },
- "description": "One or more time series that match the filter included in the request."
- },
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- }
- },
- "id": "ListTimeSeriesResponse"
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
- "LabelDescriptor": {
- "type": "object",
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
- "valueType": {
- "description": "The type of data that can be assigned to the label.",
- "type": "string",
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ]
- }
- },
- "id": "LabelDescriptor",
- "description": "A description of a label."
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "Group": {
- "description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
- "type": "object",
- "properties": {
- "displayName": {
- "description": "A user-assigned name for this group, used only for display purposes.",
- "type": "string"
- },
- "isCluster": {
- "description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.",
- "type": "boolean"
- },
- "filter": {
- "description": "The filter used to determine which monitored resources belong to this group.",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Group"
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ]
},
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "oneofs": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The list of types appearing in oneof definitions in this type."
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax proto2.",
- "Syntax proto3."
- ]
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- },
- "options": {
- "type": "array",
- "items": {
- "$ref": "Option"
- },
- "description": "The protocol buffer options."
- },
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
- },
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- }
- },
- "id": "Type"
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
},
- "BucketOptions": {
- "properties": {
- "exponentialBuckets": {
- "description": "The exponential buckets.",
- "$ref": "Exponential"
- },
- "linearBuckets": {
- "$ref": "Linear",
- "description": "The linear bucket."
- },
- "explicitBuckets": {
- "description": "The explicit buckets.",
- "$ref": "Explicit"
- }
- },
- "id": "BucketOptions",
- "description": "A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is 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.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given.",
- "type": "object"
- },
- "CollectdValue": {
- "description": "A single data point from a collectd-based plugin.",
- "type": "object",
- "properties": {
- "dataSourceType": {
- "enum": [
- "UNSPECIFIED_DATA_SOURCE_TYPE",
- "GAUGE",
- "COUNTER",
- "DERIVE",
- "ABSOLUTE"
- ],
- "description": "The type of measurement.",
- "type": "string",
- "enumDescriptions": [
- "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
- "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
- "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
- "A rate of change of the measurement.",
- "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
- ]
- },
- "dataSourceName": {
- "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".",
- "type": "string"
- },
- "value": {
- "$ref": "TypedValue",
- "description": "The measurement value."
- }
- },
- "id": "CollectdValue"
- },
- "SourceContext": {
- "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
- "type": "object",
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
- "type": "string"
- }
- },
- "id": "SourceContext"
- },
- "MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.",
- "type": "object",
- "properties": {
- "metricKind": {
- "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ]
- },
- "description": {
- "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\".",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor. 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:\n\"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"\n",
- "type": "string"
- },
- "type": {
- "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n",
- "type": "string"
- },
- "valueType": {
- "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
- "The value is a signed 64-bit integer.",
- "The value is a double precision floating point number.",
- "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
- "The value is a Distribution.",
- "The value is money."
- ],
- "enum": [
- "VALUE_TYPE_UNSPECIFIED",
- "BOOL",
- "INT64",
- "DOUBLE",
- "STRING",
- "DISTRIBUTION",
- "MONEY"
- ]
- }
- },
- "id": "MetricDescriptor"
- },
- "Range": {
- "description": "The range of the population values.",
- "type": "object",
- "properties": {
- "max": {
- "description": "The maximum of the population values.",
- "format": "double",
- "type": "number"
- },
- "min": {
- "description": "The minimum of the population values.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "Range"
- },
- "ListGroupsResponse": {
- "description": "The ListGroups response.",
- "type": "object",
- "properties": {
- "group": {
- "description": "The groups that match the specified filters.",
- "type": "array",
- "items": {
- "$ref": "Group"
- }
- },
- "nextPageToken": {
- "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.",
- "type": "string"
- }
- },
- "id": "ListGroupsResponse"
- },
+ "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": "v3",
+ "baseUrl": "https://monitoring.googleapis.com/",
+ "servicePath": "",
+ "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.",
+ "kind": "discovery#restDescription",
+ "basePath": "",
+ "id": "monitoring:v3",
+ "revision": "20170306",
+ "documentationLink": "https://cloud.google.com/monitoring/api/",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
"ListGroupMembersResponse": {
- "description": "The ListGroupMembers response.",
"type": "object",
"properties": {
"members": {
@@ -620,35 +756,36 @@
}
},
"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"
+ "type": "string",
+ "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."
},
"totalSize": {
- "type": "integer",
"description": "The total number of elements matching this request.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "ListGroupMembersResponse"
+ "id": "ListGroupMembersResponse",
+ "description": "The ListGroupMembers response."
},
"CreateCollectdTimeSeriesRequest": {
"description": "The CreateCollectdTimeSeries request.",
"type": "object",
"properties": {
+ "collectdVersion": {
+ "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\".",
+ "type": "string"
+ },
"resource": {
- "description": "The monitored resource associated with the time series.",
- "$ref": "MonitoredResource"
+ "$ref": "MonitoredResource",
+ "description": "The monitored resource associated with the time series."
},
"collectdPayloads": {
- "description": "The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.",
"type": "array",
"items": {
"$ref": "CollectdPayload"
- }
- },
- "collectdVersion": {
- "type": "string",
- "description": "The version of collectd that collected the data. Example: \"5.3.0-192.el6\"."
+ },
+ "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."
}
},
"id": "CreateCollectdTimeSeriesRequest"
@@ -676,10 +813,11 @@
"type": "object",
"properties": {
"resource": {
- "description": "The associated resource. A fully-specified monitored resource used to identify the time series.",
- "$ref": "MonitoredResource"
+ "$ref": "MonitoredResource",
+ "description": "The associated resource. A fully-specified monitored resource used to identify the time series."
},
"metricKind": {
+ "type": "string",
"enumDescriptions": [
"Do not use this default value.",
"An instantaneous measurement of a value.",
@@ -692,30 +830,20 @@
"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"
+ "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."
},
"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"
- }
+ },
+ "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."
},
"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",
@@ -726,12 +854,22 @@
"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"
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ]
}
},
"id": "TimeSeries"
},
"CreateTimeSeriesRequest": {
+ "description": "The CreateTimeSeries request.",
"type": "object",
"properties": {
"timeSeries": {
@@ -742,13 +880,22 @@
}
}
},
- "id": "CreateTimeSeriesRequest",
- "description": "The CreateTimeSeries request."
+ "id": "CreateTimeSeriesRequest"
},
"Distribution": {
"description": "Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram 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 specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).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": {
+ "mean": {
+ "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
+ "format": "double",
+ "type": "number"
+ },
+ "count": {
+ "description": "The number of values in the population. Must be non-negative.",
+ "format": "int64",
+ "type": "string"
+ },
"bucketCounts": {
"description": "If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.",
"type": "array",
@@ -767,18 +914,8 @@
"type": "number"
},
"range": {
- "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.",
- "$ref": "Range"
- },
- "count": {
- "description": "The number of values in the population. Must be non-negative.",
- "format": "int64",
- "type": "string"
- },
- "mean": {
- "description": "The arithmetic mean of the values in the population. If count is zero then this field must be zero.",
- "format": "double",
- "type": "number"
+ "$ref": "Range",
+ "description": "If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3."
}
},
"id": "Distribution"
@@ -787,16 +924,16 @@
"description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n",
"type": "object",
"properties": {
+ "type": {
+ "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is \"cloudsql_database\".",
+ "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, Cloud SQL databases use the labels \"database_id\" and \"zone\"."
- },
- "type": {
- "type": "string",
- "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is \"cloudsql_database\"."
+ "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels \"database_id\" and \"zone\".",
+ "type": "object"
}
},
"id": "MonitoredResource"
@@ -848,13 +985,621 @@
}
},
"id": "MonitoredResourceDescriptor"
+ },
+ "TypedValue": {
+ "id": "TypedValue",
+ "description": "A single strongly-typed value.",
+ "type": "object",
+ "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"
+ },
+ "stringValue": {
+ "type": "string",
+ "description": "A variable-length string value."
+ }
+ }
+ },
+ "CollectdPayload": {
+ "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.",
+ "type": "object",
+ "properties": {
+ "typeInstance": {
+ "description": "The measurement type instance. Example: \"used\".",
+ "type": "string"
+ },
+ "type": {
+ "description": "The measurement type. Example: \"memory\".",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "$ref": "TypedValue"
+ },
+ "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345",
+ "type": "object"
+ },
+ "plugin": {
+ "description": "The name of the plugin. Example: \"disk\".",
+ "type": "string"
+ },
+ "pluginInstance": {
+ "description": "The instance name of the plugin Example: \"hdcl\".",
+ "type": "string"
+ },
+ "endTime": {
+ "type": "string",
+ "description": "The end time of the interval.",
+ "format": "google-datetime"
+ },
+ "startTime": {
+ "description": "The start time of the interval.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "values": {
+ "description": "The measured values during this time interval. Each value must have a different dataSourceName.",
+ "type": "array",
+ "items": {
+ "$ref": "CollectdValue"
+ }
+ }
+ },
+ "id": "CollectdPayload"
+ },
+ "Linear": {
+ "id": "Linear",
+ "description": "Specify a 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.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i: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": {
+ "description": "Lower bound of the first bucket.",
+ "format": "double",
+ "type": "number"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "width": {
+ "description": "Must be greater than 0.",
+ "format": "double",
+ "type": "number"
+ }
+ }
+ },
+ "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": {}
+ },
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field, enumeration, etc.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive, 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"
+ },
+ "Explicit": {
+ "description": "A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.",
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "description": "The values must be monotonically increasing."
+ }
+ },
+ "id": "Explicit"
+ },
+ "TimeInterval": {
+ "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "endTime": {
+ "description": "Required. The end of the time interval.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "TimeInterval"
+ },
+ "Exponential": {
+ "type": "object",
+ "properties": {
+ "growthFactor": {
+ "description": "Must be greater than 1.",
+ "format": "double",
+ "type": "number"
+ },
+ "scale": {
+ "type": "number",
+ "description": "Must be greater than 0.",
+ "format": "double"
+ },
+ "numFiniteBuckets": {
+ "description": "Must be greater than 0.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Exponential",
+ "description": "Specify a 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.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1))."
+ },
+ "Point": {
+ "description": "A single data point in a time series.",
+ "type": "object",
+ "properties": {
+ "interval": {
+ "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.",
+ "$ref": "TimeInterval"
+ },
+ "value": {
+ "$ref": "TypedValue",
+ "description": "The value of the data point."
+ }
+ },
+ "id": "Point"
+ },
+ "Field": {
+ "description": "A single field of a message type.",
+ "type": "object",
+ "properties": {
+ "oneofIndex": {
+ "description": "The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "cardinality": {
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality.",
+ "type": "string",
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ]
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
+ "defaultValue": {
+ "type": "string",
+ "description": "The string value of the default value of this field. Proto2 syntax only."
+ },
+ "name": {
+ "description": "The field name.",
+ "type": "string"
+ },
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Timestamp\".",
+ "type": "string"
+ },
+ "number": {
+ "description": "The field number.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
+ "kind": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ],
+ "description": "The field type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Field type unknown.",
+ "Field type double.",
+ "Field type float.",
+ "Field type int64.",
+ "Field type uint64.",
+ "Field type int32.",
+ "Field type fixed64.",
+ "Field type fixed32.",
+ "Field type bool.",
+ "Field type string.",
+ "Field type group. Proto2 syntax only, and deprecated.",
+ "Field type message.",
+ "Field type bytes.",
+ "Field type uint32.",
+ "Field type enum.",
+ "Field type sfixed32.",
+ "Field type sfixed64.",
+ "Field type sint32.",
+ "Field type sint64."
+ ]
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Field"
+ },
+ "Metric": {
+ "type": "object",
+ "properties": {
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.",
+ "type": "object"
+ },
+ "type": {
+ "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.",
+ "type": "string"
+ }
+ },
+ "id": "Metric",
+ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor."
+ },
+ "LabelDescriptor": {
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "The label key.",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "A variable-length string. This is the default.",
+ "Boolean; true or false.",
+ "A 64-bit signed integer."
+ ],
+ "enum": [
+ "STRING",
+ "BOOL",
+ "INT64"
+ ],
+ "description": "The type of data that can be assigned to the label.",
+ "type": "string"
+ }
+ }
+ },
+ "ListTimeSeriesResponse": {
+ "id": "ListTimeSeriesResponse",
+ "description": "The ListTimeSeries response.",
+ "type": "object",
+ "properties": {
+ "timeSeries": {
+ "description": "One or more time series that match the filter included in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "TimeSeries"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ },
+ "description": "The list of fields."
+ },
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in oneof definitions in this type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax proto2.",
+ "Syntax proto3."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string"
+ },
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Type"
+ },
+ "Group": {
+ "id": "Group",
+ "description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.",
+ "type": "object",
+ "properties": {
+ "isCluster": {
+ "type": "boolean",
+ "description": "If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters."
+ },
+ "filter": {
+ "description": "The filter used to determine which monitored resources belong to this group.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. The name of this group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.",
+ "type": "string"
+ },
+ "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"
+ }
+ }
+ },
+ "BucketOptions": {
+ "description": "A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is 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.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given.",
+ "type": "object",
+ "properties": {
+ "exponentialBuckets": {
+ "$ref": "Exponential",
+ "description": "The exponential buckets."
+ },
+ "linearBuckets": {
+ "description": "The linear bucket.",
+ "$ref": "Linear"
+ },
+ "explicitBuckets": {
+ "$ref": "Explicit",
+ "description": "The explicit buckets."
+ }
+ },
+ "id": "BucketOptions"
+ },
+ "CollectdValue": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The measurement value.",
+ "$ref": "TypedValue"
+ },
+ "dataSourceType": {
+ "description": "The type of measurement.",
+ "type": "string",
+ "enumDescriptions": [
+ "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.",
+ "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.",
+ "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.",
+ "A rate of change of the measurement.",
+ "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA."
+ ],
+ "enum": [
+ "UNSPECIFIED_DATA_SOURCE_TYPE",
+ "GAUGE",
+ "COUNTER",
+ "DERIVE",
+ "ABSOLUTE"
+ ]
+ },
+ "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",
+ "description": "A single data point from a collectd-based plugin."
+ },
+ "SourceContext": {
+ "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext"
+ },
+ "MetricDescriptor": {
+ "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": {
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ },
+ "name": {
+ "description": "The resource name of the metric descriptor. 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:\n\"projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount\"\n",
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n"
+ },
+ "valueType": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "The value is a boolean. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a signed 64-bit integer.",
+ "The value is a double precision floating point number.",
+ "The value is a text string. This value type can be used only if the metric kind is GAUGE.",
+ "The value is a Distribution.",
+ "The value is money."
+ ],
+ "enum": [
+ "VALUE_TYPE_UNSPECIFIED",
+ "BOOL",
+ "INT64",
+ "DOUBLE",
+ "STRING",
+ "DISTRIBUTION",
+ "MONEY"
+ ],
+ "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
+ },
+ "metricKind": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points."
+ ],
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.",
+ "type": "string"
+ },
+ "description": {
+ "type": "string",
+ "description": "A detailed description of the metric, which can be used in documentation."
+ },
+ "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\".",
+ "type": "string"
+ }
+ },
+ "id": "MetricDescriptor"
+ },
+ "Range": {
+ "description": "The range of the population values.",
+ "type": "object",
+ "properties": {
+ "min": {
+ "description": "The minimum of the population values.",
+ "format": "double",
+ "type": "number"
+ },
+ "max": {
+ "description": "The maximum of the population values.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Range"
+ },
+ "ListGroupsResponse": {
+ "description": "The ListGroups response.",
+ "type": "object",
+ "properties": {
+ "group": {
+ "description": "The groups that match the specified filters.",
+ "type": "array",
+ "items": {
+ "$ref": "Group"
+ }
+ },
+ "nextPageToken": {
+ "type": "string",
+ "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."
+ }
+ },
+ "id": "ListGroupsResponse"
}
},
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
"canonicalName": "Monitoring",
"auth": {
"oauth2": {
@@ -879,750 +1624,5 @@
"name": "monitoring",
"batchPath": "batch",
"title": "Stackdriver Monitoring API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "groups": {
- "methods": {
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "parameters": {
- "name": {
- "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.delete",
- "description": "Deletes an existing group."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListGroupsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "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": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- },
- "ancestorsOfGroup": {
- "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"
- }
- },
- "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",
- "id": "monitoring.projects.groups.list",
- "path": "v3/{+name}/groups",
- "description": "Lists the existing groups."
- },
- "get": {
- "description": "Gets a single group.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Group"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/groups/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "id": "monitoring.projects.groups.get",
- "path": "v3/{+name}"
- },
- "update": {
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.groups.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"
- }
- }
- },
- "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": {
- "type": "boolean",
- "location": "query",
- "description": "If true, validate this request but do not create the group."
- }
- },
- "flatPath": "v3/projects/{projectsId}/groups",
- "path": "v3/{+name}/groups",
- "id": "monitoring.projects.groups.create"
- }
- },
- "resources": {
- "members": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListGroupMembersResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n",
- "type": "string"
- },
- "pageToken": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- },
- "interval.startTime": {
- "location": "query",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "format": "google-datetime",
- "type": "string"
- },
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32"
- },
- "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": {
- "type": "string",
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members",
- "path": "v3/{+name}/members",
- "id": "monitoring.projects.groups.members.list",
- "description": "Lists the monitored resources that are members of a group."
- }
- }
- }
- }
- },
- "collectdTimeSeries": {
- "methods": {
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/collectdTimeSeries",
- "id": "monitoring.projects.collectdTimeSeries.create",
- "path": "v3/{+name}/collectdTimeSeries",
- "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"
- }
- }
- },
- "timeSeries": {
- "methods": {
- "list": {
- "description": "Lists time series that match a filter. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "ListTimeSeriesResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read"
- ],
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.",
- "format": "int32",
- "type": "integer"
- },
- "orderBy": {
- "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.",
- "type": "string",
- "location": "query"
- },
- "aggregation.crossSeriesReducer": {
- "type": "string",
- "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."
- },
- "filter": {
- "location": "query",
- "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n",
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "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."
- },
- "aggregation.perSeriesAligner": {
- "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",
- "location": "query"
- },
- "interval.startTime": {
- "location": "query",
- "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.",
- "format": "google-datetime",
- "type": "string"
- },
- "view": {
- "type": "string",
- "location": "query",
- "enum": [
- "FULL",
- "HEADERS"
- ],
- "description": "Specifies which information is returned about the time series."
- },
- "name": {
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "aggregation.groupByFields": {
- "location": "query",
- "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.",
- "type": "string",
- "repeated": true
- },
- "interval.endTime": {
- "location": "query",
- "description": "Required. The end of the time interval.",
- "format": "google-datetime",
- "type": "string"
- },
- "aggregation.alignmentPeriod": {
- "location": "query",
- "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.",
- "format": "google-duration",
- "type": "string"
- }
- },
- "flatPath": "v3/projects/{projectsId}/timeSeries",
- "path": "v3/{+name}/timeSeries",
- "id": "monitoring.projects.timeSeries.list"
- },
- "create": {
- "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"
- },
- "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"
- }
- }
- }
- }
- },
- "metricDescriptors": {
- "methods": {
- "create": {
- "request": {
- "$ref": "MetricDescriptor"
- },
- "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.",
- "response": {
- "$ref": "MetricDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors",
- "path": "v3/{+name}/metricDescriptors",
- "id": "monitoring.projects.metricDescriptors.create"
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "location": "path",
- "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/metricDescriptors/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring"
- ],
- "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.metricDescriptors.delete",
- "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted."
- },
- "list": {
- "httpMethod": "GET",
- "response": {
- "$ref": "ListMetricDescriptorsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "location": "query",
- "description": "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"
- }
- },
- "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": {
- "description": "Gets a single metric descriptor. This method does not require a Stackdriver account.",
- "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\".",
- "required": true,
- "type": "string",
- "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}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.metricDescriptors.get"
- }
- }
- },
- "monitoredResourceDescriptors": {
- "methods": {
- "list": {
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListMonitoredResourceDescriptorsResponse"
- },
- "parameters": {
- "pageSize": {
- "description": "A positive number that is the maximum number of results to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "filter": {
- "description": "An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND resource.label:id\n",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.",
- "type": "string",
- "location": "query"
- }
- },
- "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"
- },
- "get": {
- "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.",
- "response": {
- "$ref": "MonitoredResourceDescriptor"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/monitoring",
- "https://www.googleapis.com/auth/monitoring.read",
- "https://www.googleapis.com/auth/monitoring.write"
- ],
- "parameters": {
- "name": {
- "description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/monitoredResourceDescriptors/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}",
- "path": "v3/{+name}",
- "id": "monitoring.projects.monitoredResourceDescriptors.get"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "callback": {
- "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": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "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": "v3",
- "baseUrl": "https://monitoring.googleapis.com/",
- "kind": "discovery#restDescription",
- "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.",
- "basePath": "",
- "id": "monitoring:v3",
- "documentationLink": "https://cloud.google.com/monitoring/api/",
- "revision": "20170302",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "ownerName": "Google"
}
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json
index 36d321b..4bcd7fe 100644
--- a/partners/v2/partners-api.json
+++ b/partners/v2/partners-api.json
@@ -1,1379 +1,3614 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/IsLtDjyeCcVcrLheR4Lh75k5EO4\"",
- "discoveryVersion": "v1",
- "id": "partners:v2",
- "name": "partners",
- "version": "v2",
- "revision": "20151009",
- "title": "Google Partners API",
- "description": "Lets advertisers search certified companies and create contact leads with them, and also audits the usage of clients.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/partners/",
- "protocol": "rest",
- "baseUrl": "https://partners.googleapis.com/",
- "basePath": "",
- "rootUrl": "https://partners.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "version_module": true,
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "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.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "schemas": {
- "LogUserEventRequest": {
- "id": "LogUserEventRequest",
- "type": "object",
- "description": "Request message for LogUserEvent.",
- "properties": {
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
+ "baseUrl": "https://partners.googleapis.com/",
+ "canonicalName": "Partners",
+ "servicePath": "",
+ "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://partners.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "partners",
+ "batchPath": "batch",
+ "revision": "20170303",
+ "documentationLink": "https://developers.google.com/partners/",
+ "id": "partners:v2",
+ "title": "Google Partners API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "resources": {
+ "exams": {
+ "methods": {
+ "getToken": {
+ "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ExamToken"
+ },
+ "parameterOrder": [
+ "examType"
+ ],
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "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": {
+ "description": "The exam type we are requesting a token for.",
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ]
+ }
+ },
+ "flatPath": "v2/exams/{examType}/token",
+ "id": "partners.exams.getToken",
+ "path": "v2/exams/{examType}/token"
+ }
+ }
},
- "eventAction": {
- "type": "string",
- "description": "The action that occurred.",
- "enum": [
- "EVENT_ACTION_UNSPECIFIED",
- "SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM",
- "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP",
- "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM",
- "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP",
- "SMB_CANCELED_PARTNER_CONTACT_FORM",
- "SMB_CLICKED_CONTACT_A_PARTNER",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM",
- "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM",
- "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM",
- "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM",
- "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM",
- "PARTNER_VIEWED_BY_SMB",
- "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS",
- "SMB_CHANGED_A_SEARCH_PARAMETER_TOP",
- "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS",
- "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS",
- "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA",
- "SMB_PERFORMED_SEARCH_ON_GPS",
- "SMB_VIEWED_A_PARTNER_ON_GPS",
- "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
- "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE",
- "SMB_CLICKED_PARTNER_WEBSITE",
- "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
- "SMB_VIEWED_A_PARTNER_PROFILE",
- "AGENCY_CLICKED_ACCEPT_TOS_BUTTON",
- "AGENCY_CHANGED_TOS_COUNTRY",
- "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL",
- "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION",
- "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION",
- "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL",
- "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE",
- "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL",
- "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL",
- "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE",
- "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL",
- "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
- "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
- "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL",
- "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN",
- "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION",
- "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION",
- "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL",
- "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN",
- "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL",
- "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL",
- "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN",
- "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN",
- "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE",
- "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP",
- "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
- "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
- "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL",
- "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
- "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS",
- "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL",
- "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY",
- "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY",
- "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGECNY_CLICKED_LOG_OUT_CONNECT_WITH_COMPANY_NOT_FOUND",
- "AGENCY_CLICKED_SKIP_FOR_NOW_ON_CONNECT_WITH_COMPANY_PAGE",
- "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY",
- "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY",
- "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH",
- "AGENCY_SUCCESSFULLY_CREATED_COMPANY",
- "AGENCY_ADDED_NEW_COMPANY_LOCATION",
- "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_GET_VIDEO_ADS_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS",
- "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT",
- "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED",
- "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL",
- "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL",
- "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE",
- "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE",
- "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE",
- "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE",
- "AGENCY_OPENED_LAST_ADMIN_DIALOG",
- "AGENCY_OPENED_DIALOG_WITH_NO_USERS",
- "AGENCY_PROMOTED_USER_TO_ADMIN",
- "AGENCY_UNAFFILIATED",
- "AGENCY_CHANGED_ROLES",
- "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE",
- "SMB_VIEWED_ADWORDS_CERTIFICATE",
- "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON",
- "SMB_VIEWED_ANALYTICS_CERTIFICATE",
- "SMB_VIEWED_DOUBLECLICK_CERTIFICATE",
- "SMB_VIEWED_VIDEO_ADS_CERTIFICATE",
- "SMB_VIEWED_SHOPPING_CERTIFICATE",
- "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON",
- "CLICKED_HELP_AT_BOTTOM",
- "CLICKED_HELP_AT_TOP",
- "CLIENT_ERROR",
- "AGENCY_CLICKED_LEFT_NAV_STORIES",
- "CLICKED",
- "SMB_VIEWED_MOBILE_CERTIFICATE",
- "AGENCY_FAILED_COMPANY_VERIFICATION",
- "VISITED_LANDING",
- "VISITED_GPS",
- "VISITED_AGENCY_PORTAL",
- "CANCELLED_INDIVIDUAL_SIGN_UP",
- "CANCELLED_COMPANY_SIGN_UP",
- "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP",
- "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE",
- "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
- "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
- "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
- "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS",
- "AGENCY_LINKED_INDIVIDUAL_MCC",
- "AGENCY_SUGGESTED_TO_USER",
- "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED",
- "AGENCY_PICKED_SUGGESTED_AGENCY",
- "AGENCY_SEARCHED_FOR_AGENCIES",
- "AGENCY_PICKED_SEARCHED_AGENCY",
- "AGENCY_DISMISSED_AFFILIATION_WIDGET",
- "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT",
- "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT",
- "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
- "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM"
- ]
+ "leads": {
+ "methods": {
+ "list": {
+ "flatPath": "v2/leads",
+ "id": "partners.leads.list",
+ "path": "v2/leads",
+ "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListLeadsResponse"
+ },
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "orderBy": {
+ "location": "query",
+ "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ "type": "string"
+ }
+ }
+ }
+ }
},
- "eventCategory": {
- "type": "string",
- "description": "The category the action belongs to.",
- "enum": [
- "EVENT_CATEGORY_UNSPECIFIED",
- "GOOGLE_PARTNER_SEARCH",
- "GOOGLE_PARTNER_SIGNUP_FLOW",
- "GOOGLE_PARTNER_PORTAL",
- "GOOGLE_PARTNER_PORTAL_MY_PROFILE",
- "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS",
- "GOOGLE_PARTNER_PORTAL_COMMUNITY",
- "GOOGLE_PARTNER_PORTAL_INSIGHTS",
- "GOOGLE_PARTNER_PORTAL_CLIENTS",
- "GOOGLE_PARTNER_PUBLIC_USER_PROFILE",
- "GOOGLE_PARTNER_PANEL",
- "GOOGLE_PARTNER_PORTAL_LAST_ADMIN_DIALOG",
- "GOOGLE_PARTNER_CLIENT",
- "GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE",
- "EXTERNAL_LINKS",
- "GOOGLE_PARTNER_LANDING"
- ]
- },
- "eventScope": {
- "type": "string",
- "description": "The scope of the event.",
- "enum": [
- "EVENT_SCOPE_UNSPECIFIED",
- "VISITOR",
- "SESSION",
- "PAGE"
- ]
- },
- "eventDatas": {
- "type": "array",
- "description": "List of event data for the event.",
- "items": {
- "$ref": "EventData"
- }
- },
- "url": {
- "type": "string",
- "description": "The URL where the event occurred."
- },
- "lead": {
- "$ref": "Lead",
- "description": "Advertiser lead information."
- }
- }
- },
- "RequestMetadata": {
- "id": "RequestMetadata",
- "type": "object",
- "description": "Common data that is in each API request.",
- "properties": {
- "userOverrides": {
- "$ref": "UserOverrides",
- "description": "Values to use instead of the user's respective defaults for the current request. These are only honored by whitelisted products."
- },
- "locale": {
- "type": "string",
- "description": "Locale to use for the current request."
- },
- "partnersSessionId": {
- "type": "string",
- "description": "Google Partners session ID."
- },
- "experimentIds": {
- "type": "array",
- "description": "Experiment IDs the current request belongs to.",
- "items": {
- "type": "string"
- }
- },
- "trafficSource": {
- "$ref": "TrafficSource",
- "description": "Source of traffic for the current request."
- }
- }
- },
- "UserOverrides": {
- "id": "UserOverrides",
- "type": "object",
- "description": "Values to use instead of the user's respective defaults. These are only honored by whitelisted products.",
- "properties": {
- "ipAddress": {
- "type": "string",
- "description": "IP address to use instead of the user's geo-located IP address."
- },
- "userId": {
- "type": "string",
- "description": "Logged-in user ID to impersonate instead of the user's ID."
- }
- }
- },
- "TrafficSource": {
- "id": "TrafficSource",
- "type": "object",
- "description": "Source of traffic for the current request.",
- "properties": {
- "trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us."
- },
- "trafficSubId": {
- "type": "string",
- "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us."
- }
- }
- },
- "EventData": {
- "id": "EventData",
- "type": "object",
- "description": "Key value data pair for an event.",
- "properties": {
- "key": {
- "type": "string",
- "description": "Data type.",
- "enum": [
- "EVENT_DATA_TYPE_UNSPECIFIED",
- "ACTION",
- "AGENCY_ID",
- "AGENCY_NAME",
- "AGENCY_PHONE_NUMBER",
- "AGENCY_WEBSITE",
- "BUDGET",
- "CENTER_POINT",
- "CERTIFICATION",
- "COMMENT",
- "COUNTRY",
- "CURRENCY",
- "CURRENTLY_VIEWED_AGENCY_ID",
- "DISTANCE",
- "DISTANCE_TYPE",
- "EXAM",
- "HISTORY_TOKEN",
- "IDENTIFIER",
- "INDUSTRY",
- "INSIGHT_TAG",
- "LANGUAGE",
- "LOCATION",
- "MARKETING_OPT_IN",
- "QUERY",
- "SEARCH_START_INDEX",
- "SERVICE",
- "SHOW_VOW",
- "SOLUTION",
- "TRAFFIC_SOURCE_ID",
- "TRAFFIC_SUB_ID",
- "VIEW_PORT",
- "WEBSITE",
- "DETAILS",
- "EXPERIMENT_ID",
- "GPS_MOTIVATION",
- "URL",
- "ELEMENT_FOCUS",
- "PROGRESS"
- ]
- },
- "values": {
- "type": "array",
- "description": "Data values.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Lead": {
- "id": "Lead",
- "type": "object",
- "description": "A lead resource that represents an advertiser contact for a `Company`. These are usually generated via Google Partner Search (the advertiser portal).",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of the lead."
- },
- "type": {
- "type": "string",
- "description": "Type of lead.",
- "enum": [
- "LEAD_TYPE_UNSPECIFIED",
- "LT_GPS"
- ]
- },
- "email": {
- "type": "string",
- "description": "Email address of lead source."
- },
- "givenName": {
- "type": "string",
- "description": "First name of lead source."
- },
- "familyName": {
- "type": "string",
- "description": "Last name of lead source."
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website URL of lead source."
- },
- "phoneNumber": {
- "type": "string",
- "description": "Phone number of lead source."
- },
- "comments": {
- "type": "string",
- "description": "Comments lead source gave."
- },
- "gpsMotivations": {
- "type": "array",
- "description": "List of reasons for using Google Partner Search and creating a lead.",
- "enumDescriptions": [
- "Unchosen.",
- "Advertiser needs help with their advertising.",
- "Advertiser needs help with their website.",
- "Advertiser does not have a website."
- ],
- "items": {
- "type": "string",
- "enum": [
- "GPS_MOTIVATION_UNSPECIFIED",
- "GPSM_HELP_WITH_ADVERTISING",
- "GPSM_HELP_WITH_WEBSITE",
- "GPSM_NO_WEBSITE"
- ]
- }
- },
- "minMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget lead source is willing to spend."
- }
- }
- },
- "Money": {
- "id": "Money",
- "type": "object",
- "description": "Represents an amount of money with its currency type.",
- "properties": {
- "currencyCode": {
- "type": "string",
- "description": "The 3-letter currency code defined in ISO 4217."
- },
- "units": {
- "type": "string",
- "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64"
- },
- "nanos": {
- "type": "integer",
- "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32"
- }
- }
- },
- "LogUserEventResponse": {
- "id": "LogUserEventResponse",
- "type": "object",
- "description": "Response message for LogUserEvent.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- }
- },
- "ResponseMetadata": {
- "id": "ResponseMetadata",
- "type": "object",
- "description": "Common data that is in each API response.",
- "properties": {
- "debugInfo": {
- "$ref": "DebugInfo",
- "description": "Debug information about this request."
- }
- }
- },
- "DebugInfo": {
- "id": "DebugInfo",
- "type": "object",
- "description": "Debug information about this request.",
- "properties": {
- "serverInfo": {
- "type": "string",
- "description": "Info about the server that serviced this request."
- },
- "serviceUrl": {
- "type": "string",
- "description": "URL of the service that handled this request."
- },
- "serverTraceInfo": {
- "type": "string",
- "description": "Server-side debug stack trace."
- }
- }
- },
- "LogMessageRequest": {
- "id": "LogMessageRequest",
- "type": "object",
- "description": "Request message for LogClientMessage.",
- "properties": {
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "level": {
- "type": "string",
- "description": "Message level of client message.",
- "enum": [
- "MESSAGE_LEVEL_UNSPECIFIED",
- "ML_FINE",
- "ML_INFO",
- "ML_WARNING",
- "ML_SEVERE"
- ]
- },
- "details": {
- "type": "string",
- "description": "Details about the client message."
- },
- "clientInfo": {
- "type": "object",
- "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
- "additionalProperties": {
- "type": "string"
- }
- }
- }
- },
- "LogMessageResponse": {
- "id": "LogMessageResponse",
- "type": "object",
- "description": "Response message for LogClientMessage.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- }
- }
- },
- "ListUserStatesResponse": {
- "id": "ListUserStatesResponse",
- "type": "object",
- "description": "Response message for ListUserStates.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "offers": {
+ "methods": {
+ "list": {
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListOffersResponse"
+ },
+ "parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/offers",
+ "id": "partners.offers.list",
+ "path": "v2/offers",
+ "description": "Lists the Offers available for the current user"
+ }
+ },
+ "resources": {
+ "history": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListOffersHistoryResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Token to retrieve a specific page.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Maximum number of rows to return per page.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "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"
+ },
+ "entireCompany": {
+ "location": "query",
+ "description": "if true, show history for the entire company. Requires user to be admin.",
+ "type": "boolean"
+ },
+ "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"
+ },
+ "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",
+ "path": "v2/offers/history",
+ "id": "partners.offers.history.list",
+ "description": "Lists the Historical Offers for the current user (or user's entire company)"
+ }
+ }
+ }
+ }
},
"userStates": {
- "type": "array",
- "description": "User's states.",
- "enumDescriptions": [
- "Unchosen.",
- "User must pass reCaptcha to contact a Partner via Google Partner Search."
- ],
- "items": {
- "type": "string",
- "enum": [
- "USER_STATE_UNSPECIFIED",
- "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
- ]
- }
- }
- }
- },
- "GetCompanyResponse": {
- "id": "GetCompanyResponse",
- "type": "object",
- "description": "Response message for GetCompany.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "methods": {
+ "list": {
+ "flatPath": "v2/userStates",
+ "id": "partners.userStates.list",
+ "path": "v2/userStates",
+ "description": "Lists states for current user.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListUserStatesResponse"
+ },
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "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": {
+ "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"
+ }
+ }
+ }
+ }
},
- "company": {
- "$ref": "Company",
- "description": "The company."
- }
- }
- },
- "Company": {
- "id": "Company",
- "type": "object",
- "description": "A company resource in the Google Partners API. Once certified, it qualifies for being searched by advertisers.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the company."
+ "analytics": {
+ "methods": {
+ "list": {
+ "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListAnalyticsResponse"
+ },
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "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/analytics",
+ "id": "partners.analytics.list",
+ "path": "v2/analytics"
+ }
+ }
},
- "name": {
- "type": "string",
- "description": "The name of the company."
+ "v2": {
+ "methods": {
+ "updateCompanies": {
+ "description": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ "request": {
+ "$ref": "Company"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Company"
+ },
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "updateMask": {
+ "location": "query",
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "flatPath": "v2/companies",
+ "id": "partners.updateCompanies",
+ "path": "v2/companies"
+ },
+ "getPartnersstatus": {
+ "response": {
+ "$ref": "GetPartnersStatusResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "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": {
+ "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/partnersstatus",
+ "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": {
+ "description": "Updates the specified lead.",
+ "request": {
+ "$ref": "Lead"
+ },
+ "httpMethod": "PATCH",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Lead"
+ },
+ "parameters": {
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "updateMask": {
+ "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ "format": "google-fieldmask",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/leads",
+ "id": "partners.updateLeads",
+ "path": "v2/leads"
+ }
+ }
},
- "localizedInfos": {
- "type": "array",
- "description": "The list of localized info for the company.",
- "items": {
- "$ref": "LocalizedCompanyInfo"
- }
- },
- "locations": {
- "type": "array",
- "description": "The list of company locations.",
- "items": {
- "$ref": "Location"
- }
- },
- "convertedMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The minimum monthly budget that the company accepts for partner business, converted to the requested currency code."
- },
- "originalMinMonthlyBudget": {
- "$ref": "Money",
- "description": "The unconverted minimum monthly budget that the company accepts for partner business."
- },
- "publicProfile": {
- "$ref": "PublicProfile",
- "description": "Basic information from the company's public profile."
- },
- "certificationStatuses": {
- "type": "array",
- "description": "The list of Google Partners certification statuses for the company.",
- "items": {
- "$ref": "CertificationStatus"
- }
- },
- "ranks": {
- "type": "array",
- "description": "Information related to the ranking of the company within the list of companies.",
- "items": {
- "$ref": "Rank"
- }
- },
- "websiteUrl": {
- "type": "string",
- "description": "URL of the company's website."
- },
- "industries": {
- "type": "array",
- "description": "Industries the company can help with.",
- "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."
- ],
- "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"
- ]
- }
- },
- "services": {
- "type": "array",
- "description": "Services the company can help with.",
- "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."
- ],
- "items": {
- "type": "string",
- "enum": [
- "SERVICE_UNSPECIFIED",
- "S_ADVANCED_ADWORDS_SUPPORT",
- "S_ADVERTISING_ON_GOOGLE",
- "S_AN_ENHANCED_WEBSITE",
- "S_AN_ONLINE_MARKETING_PLAN",
- "S_MOBILE_AND_VIDEO_ADS"
- ]
- }
- }
- }
- },
- "LocalizedCompanyInfo": {
- "id": "LocalizedCompanyInfo",
- "type": "object",
- "description": "The localized company information.",
- "properties": {
- "languageCode": {
- "type": "string",
- "description": "Language code of the localized company info, as defined by BCP 47 (IETF BCP 47, \"Tags for Identifying Languages\")."
- },
- "displayName": {
- "type": "string",
- "description": "Localized display name."
- },
- "overview": {
- "type": "string",
- "description": "Localized brief description that the company uses to advertise themselves."
- },
- "countryCodes": {
- "type": "array",
- "description": "List of country codes for the localized company info.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Location": {
- "id": "Location",
- "type": "object",
- "description": "A location with address and geographic coordinates.",
- "properties": {
- "address": {
- "type": "string",
- "description": "The complete address of the location."
- },
- "latLng": {
- "$ref": "LatLng",
- "description": "The latitude and longitude of the location, in degrees."
- }
- }
- },
- "LatLng": {
- "id": "LatLng",
- "type": "object",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): \"\"\"Wrapsdecimal degrees longitude to [-180.0, 180.0].\"\"\" q, r = divmod(longitude, 360.0) if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): \"\"\"Wraps decimal degrees latitude and longitude to [-180.0, 180.0] and [-90.0, 90.0], respectively.\"\"\" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "properties": {
- "latitude": {
- "type": "number",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double"
- }
- }
- },
- "PublicProfile": {
- "id": "PublicProfile",
- "type": "object",
- "description": "Basic information from a public profile.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID which can be used to retrieve more details about the public profile."
- },
- "displayName": {
- "type": "string",
- "description": "The display name of the public profile."
- },
- "url": {
- "type": "string",
- "description": "The URL of the public profile."
- },
- "displayImageUrl": {
- "type": "string",
- "description": "The URL to the main display image of the public profile."
- }
- }
- },
- "CertificationStatus": {
- "id": "CertificationStatus",
- "type": "object",
- "description": "Google Partners certification status.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of the certification.",
- "enum": [
- "CERTIFICATION_TYPE_UNSPECIFIED",
- "CT_ADWORDS",
- "CT_YOUTUBE",
- "CT_VIDEOADS",
- "CT_ANALYTICS",
- "CT_DOUBLECLICK",
- "CT_SHOPPING",
- "CT_MOBILE"
- ]
- },
- "examStatuses": {
- "type": "array",
- "description": "List of certification exam statuses.",
- "items": {
- "$ref": "CertificationExamStatus"
- }
- },
- "isCertified": {
- "type": "boolean",
- "description": "Whether certification is passing."
- }
- }
- },
- "CertificationExamStatus": {
- "id": "CertificationExamStatus",
- "type": "object",
- "description": "Status for a Google Partners certification exam.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of certification exam.",
- "enum": [
- "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
- "CET_ADWORDS_ADVANCED_SEARCH",
- "CET_ADWORDS_ADVANCED_DISPLAY",
- "CET_VIDEO_ADS",
- "CET_ANALYTICS",
- "CET_DOUBLECLICK",
- "CET_SHOPPING",
- "CET_MOBILE"
- ]
- },
- "numberUsersPass": {
- "type": "integer",
- "description": "The number of people who have passed the certification exam.",
- "format": "int32"
- }
- }
- },
- "Rank": {
- "id": "Rank",
- "type": "object",
- "description": "Information related to ranking of results.",
- "properties": {
- "type": {
- "type": "string",
- "description": "The type of rank.",
- "enum": [
- "RANK_TYPE_UNSPECIFIED",
- "RT_FINAL_SCORE"
- ]
- },
- "value": {
- "type": "number",
- "description": "The numerical value of the rank.",
- "format": "double"
- }
- }
- },
- "ListCompaniesResponse": {
- "id": "ListCompaniesResponse",
- "type": "object",
- "description": "Response message for ListCompanies.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
+ "users": {
+ "methods": {
+ "createCompanyRelation": {
+ "request": {
+ "$ref": "CompanyRelation"
+ },
+ "description": "Creates a user's company relation. Affiliates the user to a company.",
+ "response": {
+ "$ref": "CompanyRelation"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "PUT",
+ "parameters": {
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "userId": {
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "required": true,
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "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"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.createCompanyRelation"
+ },
+ "deleteCompanyRelation": {
+ "description": "Deletes a user's company relation. Unaffiliaites the user from a company.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "requestMetadata.partnersSessionId": {
+ "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": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "userId": {
+ "location": "path",
+ "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/users/{userId}/companyRelation",
+ "path": "v2/users/{userId}/companyRelation",
+ "id": "partners.users.deleteCompanyRelation"
+ },
+ "get": {
+ "flatPath": "v2/users/{userId}",
+ "path": "v2/users/{userId}",
+ "id": "partners.users.get",
+ "description": "Gets a user.",
+ "response": {
+ "$ref": "User"
+ },
+ "parameterOrder": [
+ "userId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "location": "query",
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "userView": {
+ "description": "Specifies what parts of the user information to return.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "BASIC",
+ "PROFILE",
+ "PUBLIC_PROFILE"
+ ]
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "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": {
+ "location": "query",
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "userId": {
+ "location": "path",
+ "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ "required": true,
+ "type": "string"
+ }
+ }
+ },
+ "updateProfile": {
+ "flatPath": "v2/users/profile",
+ "path": "v2/users/profile",
+ "id": "partners.users.updateProfile",
+ "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.",
+ "request": {
+ "$ref": "UserProfile"
+ },
+ "response": {
+ "$ref": "UserProfile"
+ },
+ "parameterOrder": [],
+ "httpMethod": "PATCH",
+ "parameters": {
+ "requestMetadata.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "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.trafficSource.trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "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"
+ }
+ }
+ }
+ }
},
"companies": {
- "type": "array",
- "description": "The list of companies.",
- "items": {
- "$ref": "Company"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "A token to retrieve next page of results. Pass this value in the `ListCompaniesRequest.page_token` field in the subsequent call to ListCompanies to retrieve the next page of results."
- }
- }
- },
- "CreateLeadRequest": {
- "id": "CreateLeadRequest",
- "type": "object",
- "description": "Request message for CreateLead.",
- "properties": {
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Current request metadata."
- },
- "lead": {
- "$ref": "Lead",
- "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED` and either `email` or `phone_number` must be provided."
- },
- "recaptchaChallenge": {
- "$ref": "RecaptchaChallenge",
- "description": "reCaptcha challenge info."
- }
- }
- },
- "RecaptchaChallenge": {
- "id": "RecaptchaChallenge",
- "type": "object",
- "description": "reCaptcha challenge info.",
- "properties": {
- "id": {
- "type": "string",
- "description": "The ID of the reCaptcha challenge."
- },
- "response": {
- "type": "string",
- "description": "The response to the reCaptcha challenge."
- }
- }
- },
- "CreateLeadResponse": {
- "id": "CreateLeadResponse",
- "type": "object",
- "description": "Response message for CreateLead. Debug information about this request.",
- "properties": {
- "responseMetadata": {
- "$ref": "ResponseMetadata",
- "description": "Current response metadata."
- },
- "lead": {
- "$ref": "Lead",
- "description": "Lead that was created depending on the outcome of reCaptcha validation."
- },
- "recaptchaStatus": {
- "type": "string",
- "description": "The outcome of reCaptcha validation.",
- "enum": [
- "RECAPTCHA_STATUS_UNSPECIFIED",
- "RS_NOT_NEEDED",
- "RS_PASSED",
- "RS_FAILED"
- ]
- }
- }
- }
- },
- "resources": {
- "userEvents": {
- "methods": {
- "log": {
- "id": "partners.userEvents.log",
- "path": "v2/userEvents:log",
- "httpMethod": "POST",
- "description": "Logs a user event.",
- "request": {
- "$ref": "LogUserEventRequest"
- },
- "response": {
- "$ref": "LogUserEventResponse"
- }
- }
- }
- },
- "clientMessages": {
- "methods": {
- "log": {
- "id": "partners.clientMessages.log",
- "path": "v2/clientMessages:log",
- "httpMethod": "POST",
- "description": "Logs a generic message from the client, such as `Failed to render component`, `Profile page is running slow`, `More than 500 users have accessed this result.`, etc.",
- "request": {
- "$ref": "LogMessageRequest"
- },
- "response": {
- "$ref": "LogMessageResponse"
- }
- }
- }
- },
- "userStates": {
- "methods": {
- "list": {
- "id": "partners.userStates.list",
- "path": "v2/userStates",
- "httpMethod": "GET",
- "description": "Lists states for current user.",
- "parameters": {
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query"
- },
- "requestMetadata.locale": {
- "type": "string",
- "description": "Locale to use for the current request.",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "description": "Google Partners session ID.",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "description": "Experiment IDs the current request belongs to.",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListUserStatesResponse"
- }
- }
- }
- },
- "companies": {
- "methods": {
- "get": {
- "id": "partners.companies.get",
- "path": "v2/companies/{companyId}",
- "httpMethod": "GET",
- "description": "Gets a company.",
- "parameters": {
- "companyId": {
- "type": "string",
- "description": "The ID of the company to retrieve.",
- "required": true,
- "location": "path"
- },
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query"
- },
- "requestMetadata.locale": {
- "type": "string",
- "description": "Locale to use for the current request.",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "description": "Google Partners session ID.",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "description": "Experiment IDs the current request belongs to.",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.",
- "location": "query"
- },
- "currencyCode": {
- "type": "string",
- "description": "If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.",
- "location": "query"
- },
- "address": {
- "type": "string",
- "description": "The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "companyId"
- ],
- "response": {
- "$ref": "GetCompanyResponse"
- }
- },
- "list": {
- "id": "partners.companies.list",
- "path": "v2/companies",
- "httpMethod": "GET",
- "description": "Lists companies.",
- "parameters": {
- "requestMetadata.userOverrides.ipAddress": {
- "type": "string",
- "description": "IP address to use instead of the user's geo-located IP address.",
- "location": "query"
- },
- "requestMetadata.userOverrides.userId": {
- "type": "string",
- "description": "Logged-in user ID to impersonate instead of the user's ID.",
- "location": "query"
- },
- "requestMetadata.locale": {
- "type": "string",
- "description": "Locale to use for the current request.",
- "location": "query"
- },
- "requestMetadata.partnersSessionId": {
- "type": "string",
- "description": "Google Partners session ID.",
- "location": "query"
- },
- "requestMetadata.experimentIds": {
- "type": "string",
- "description": "Experiment IDs the current request belongs to.",
- "repeated": true,
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSourceId": {
- "type": "string",
- "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- },
- "requestMetadata.trafficSource.trafficSubId": {
- "type": "string",
- "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies.",
- "location": "query"
- },
- "companyName": {
- "type": "string",
- "description": "Company name to search for.",
- "location": "query"
- },
- "view": {
- "type": "string",
- "description": "The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.",
- "enum": [
- "COMPANY_VIEW_UNSPECIFIED",
- "CV_GOOGLE_PARTNER_SEARCH"
- ],
- "location": "query"
- },
- "minMonthlyBudget.currencyCode": {
- "type": "string",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "location": "query"
- },
- "minMonthlyBudget.units": {
- "type": "string",
- "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "location": "query"
- },
- "minMonthlyBudget.nanos": {
- "type": "integer",
- "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "location": "query"
- },
- "maxMonthlyBudget.currencyCode": {
- "type": "string",
- "description": "The 3-letter currency code defined in ISO 4217.",
- "location": "query"
- },
- "maxMonthlyBudget.units": {
- "type": "string",
- "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
- "format": "int64",
- "location": "query"
- },
- "maxMonthlyBudget.nanos": {
- "type": "integer",
- "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "location": "query"
- },
- "industries": {
- "type": "string",
- "description": "List of industries the company can help with.",
- "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"
- ],
- "repeated": true,
- "location": "query"
- },
- "services": {
- "type": "string",
- "description": "List of services the company can help with.",
- "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"
- ],
- "repeated": true,
- "location": "query"
- },
- "languageCodes": {
- "type": "string",
- "description": "List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, \"Tags for Identifying Languages\").",
- "repeated": true,
- "location": "query"
- },
- "address": {
- "type": "string",
- "description": "The address to use when searching for companies. If not given, the geo-located address of the request is used.",
- "location": "query"
- },
- "orderBy": {
- "type": "string",
- "description": "How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.",
- "location": "query"
- },
- "gpsMotivations": {
- "type": "string",
- "description": "List of reasons for using Google Partner Search to get companies.",
- "enum": [
- "GPS_MOTIVATION_UNSPECIFIED",
- "GPSM_HELP_WITH_ADVERTISING",
- "GPSM_HELP_WITH_WEBSITE",
- "GPSM_NO_WEBSITE"
- ],
- "repeated": true,
- "location": "query"
- },
- "websiteUrl": {
- "type": "string",
- "description": "Website URL that will help to find a better matched company. .",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListCompaniesResponse"
- }
- }
- },
- "resources": {
- "leads": {
- "methods": {
- "create": {
- "id": "partners.companies.leads.create",
- "path": "v2/companies/{companyId}/leads",
- "httpMethod": "POST",
- "description": "Creates an advertiser lead for the given company ID.",
- "parameters": {
- "companyId": {
- "type": "string",
- "description": "The ID of the company to contact.",
- "required": true,
- "location": "path"
+ "methods": {
+ "get": {
+ "parameterOrder": [
+ "companyId"
+ ],
+ "response": {
+ "$ref": "GetCompanyResponse"
+ },
+ "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.userOverrides.ipAddress": {
+ "location": "query",
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ },
+ "companyId": {
+ "description": "The ID of the company to retrieve.",
+ "required": true,
+ "type": "string",
+ "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"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string",
+ "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.partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "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": {
+ "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ]
+ },
+ "requestMetadata.locale": {
+ "location": "query",
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ },
+ "address": {
+ "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v2/companies/{companyId}",
+ "path": "v2/companies/{companyId}",
+ "id": "partners.companies.get",
+ "description": "Gets a company."
+ },
+ "list": {
+ "flatPath": "v2/companies",
+ "id": "partners.companies.list",
+ "path": "v2/companies",
+ "description": "Lists companies.",
+ "httpMethod": "GET",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "ListCompaniesResponse"
+ },
+ "parameters": {
+ "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": {
+ "location": "query",
+ "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "requestMetadata.userOverrides.ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string",
+ "location": "query"
+ },
+ "requestMetadata.experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "orderBy": {
+ "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
+ "type": "string",
+ "location": "query"
+ },
+ "specializations": {
+ "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"
+ },
+ "requestMetadata.userOverrides.userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string",
+ "location": "query"
+ },
+ "view": {
+ "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
+ "type": "string",
+ "location": "query",
+ "enum": [
+ "COMPANY_VIEW_UNSPECIFIED",
+ "CV_GOOGLE_PARTNER_SEARCH"
+ ]
+ },
+ "address": {
+ "location": "query",
+ "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
+ "type": "string"
+ },
+ "requestMetadata.locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string",
+ "location": "query"
+ },
+ "minMonthlyBudget.units": {
+ "location": "query",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "maxMonthlyBudget.nanos": {
+ "location": "query",
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "services": {
+ "location": "query",
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ],
+ "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.",
+ "type": "string",
+ "repeated": true
+ },
+ "requestMetadata.trafficSource.trafficSourceId": {
+ "location": "query",
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "maxMonthlyBudget.units": {
+ "location": "query",
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "requestMetadata.trafficSource.trafficSubId": {
+ "location": "query",
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "minMonthlyBudget.nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestMetadata.partnersSessionId": {
+ "location": "query",
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "companyName": {
+ "location": "query",
+ "description": "Company name to search for.",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.",
+ "type": "string"
+ },
+ "industries": {
+ "location": "query",
+ "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"
+ ],
+ "description": "List of industries the company can help with.",
+ "type": "string",
+ "repeated": true
+ },
+ "websiteUrl": {
+ "description": "Website URL that will help to find a better matched company.\n.",
+ "type": "string",
+ "location": "query"
+ },
+ "gpsMotivations": {
+ "location": "query",
+ "enum": [
+ "GPS_MOTIVATION_UNSPECIFIED",
+ "GPSM_HELP_WITH_ADVERTISING",
+ "GPSM_HELP_WITH_WEBSITE",
+ "GPSM_NO_WEBSITE"
+ ],
+ "description": "List of reasons for using Google Partner Search to get companies.",
+ "type": "string",
+ "repeated": true
+ }
+ }
}
- },
- "parameterOrder": [
- "companyId"
- ],
- "request": {
- "$ref": "CreateLeadRequest"
- },
- "response": {
- "$ref": "CreateLeadResponse"
- }
+ },
+ "resources": {
+ "leads": {
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "companyId"
+ ],
+ "response": {
+ "$ref": "CreateLeadResponse"
+ },
+ "parameters": {
+ "companyId": {
+ "location": "path",
+ "description": "The ID of the company to contact.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v2/companies/{companyId}/leads",
+ "id": "partners.companies.leads.create",
+ "path": "v2/companies/{companyId}/leads",
+ "request": {
+ "$ref": "CreateLeadRequest"
+ },
+ "description": "Creates an advertiser lead for the given company ID."
+ }
+ }
+ }
}
- }
+ },
+ "userEvents": {
+ "methods": {
+ "log": {
+ "description": "Logs a user event.",
+ "request": {
+ "$ref": "LogUserEventRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "LogUserEventResponse"
+ },
+ "parameters": {},
+ "flatPath": "v2/userEvents:log",
+ "id": "partners.userEvents.log",
+ "path": "v2/userEvents:log"
+ }
+ }
+ },
+ "clientMessages": {
+ "methods": {
+ "log": {
+ "flatPath": "v2/clientMessages:log",
+ "id": "partners.clientMessages.log",
+ "path": "v2/clientMessages:log",
+ "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.",
+ "request": {
+ "$ref": "LogMessageRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "LogMessageResponse"
+ },
+ "parameters": {}
+ }
+ }
}
- }
- }
- }
+ },
+ "parameters": {
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use 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"
+ }
+ },
+ "schemas": {
+ "LogMessageResponse": {
+ "description": "Response message for\nLogClientMessage.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "LogMessageResponse"
+ },
+ "SpecializationStatus": {
+ "description": "Agency specialization status",
+ "type": "object",
+ "properties": {
+ "badgeSpecialization": {
+ "enumDescriptions": [
+ "Unknown specialization",
+ "AdWords Search specialization",
+ "AdWords Display specialization",
+ "AdWords Mobile specialization",
+ "AdWords Video specialization",
+ "AdWords Shopping specialization"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_UNKNOWN",
+ "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+ ],
+ "description": "The specialization this status is for.",
+ "type": "string"
+ },
+ "badgeSpecializationState": {
+ "enumDescriptions": [
+ "Unknown state",
+ "Specialization passed",
+ "Specialization not passed",
+ "Specialization in grace"
+ ],
+ "enum": [
+ "BADGE_SPECIALIZATION_STATE_UNKNOWN",
+ "BADGE_SPECIALIZATION_STATE_PASSED",
+ "BADGE_SPECIALIZATION_STATE_NOT_PASSED",
+ "BADGE_SPECIALIZATION_STATE_IN_GRACE"
+ ],
+ "description": "State of agency specialization.",
+ "type": "string"
+ }
+ },
+ "id": "SpecializationStatus"
+ },
+ "Certification": {
+ "description": "A user's information on a specific certification.",
+ "type": "object",
+ "properties": {
+ "achieved": {
+ "description": "Whether this certification has been achieved.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Date this certification is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Whether this certification is in the state of warning.",
+ "type": "boolean"
+ },
+ "certificationType": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of certification, the area of expertise.",
+ "type": "string"
+ },
+ "lastAchieved": {
+ "description": "The date the user last achieved certification.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "Certification"
+ },
+ "User": {
+ "description": "A resource representing a user of the Partners platform.",
+ "type": "object",
+ "properties": {
+ "profile": {
+ "$ref": "UserProfile",
+ "description": "The profile information of a Partners user, contains all the directly\neditable user information."
+ },
+ "company": {
+ "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company.",
+ "$ref": "CompanyRelation"
+ },
+ "lastAccessTime": {
+ "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "availableAdwordsManagerAccounts": {
+ "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "AdWordsManagerAccountInfo"
+ }
+ },
+ "primaryEmails": {
+ "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "examStatus": {
+ "description": "The list of exams the user ever taken. For each type of exam, only one\nentry is listed.",
+ "type": "array",
+ "items": {
+ "$ref": "ExamStatus"
+ }
+ },
+ "id": {
+ "description": "The ID of the user.",
+ "type": "string"
+ },
+ "publicProfile": {
+ "description": "Information about a user's external public profile outside Google Partners.",
+ "$ref": "PublicProfile"
+ },
+ "companyVerificationEmail": {
+ "description": "The email address used by the user used for company verification.\n@OutputOnly",
+ "type": "string"
+ },
+ "certificationStatus": {
+ "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly",
+ "type": "array",
+ "items": {
+ "$ref": "Certification"
+ }
+ }
+ },
+ "id": "User"
+ },
+ "ListAnalyticsResponse": {
+ "description": "Response message for\nListAnalytics.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "analyticsSummary": {
+ "description": "Aggregated information across the response's\nanalytics.",
+ "$ref": "AnalyticsSummary"
+ },
+ "analytics": {
+ "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.",
+ "type": "array",
+ "items": {
+ "$ref": "Analytics"
+ }
+ }
+ },
+ "id": "ListAnalyticsResponse"
+ },
+ "ListLeadsResponse": {
+ "description": "Response message for ListLeads.",
+ "type": "object",
+ "properties": {
+ "leads": {
+ "description": "The list of leads.",
+ "type": "array",
+ "items": {
+ "$ref": "Lead"
+ }
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ },
+ "totalSize": {
+ "description": "The total count of leads for the given company.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListLeadsResponse"
+ },
+ "Company": {
+ "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.",
+ "type": "object",
+ "properties": {
+ "industries": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "The automotive industry.",
+ "The business-to-business industry.",
+ "The consumer packaged goods industry.",
+ "The education industry.",
+ "The finance industry.",
+ "The healthcare industry.",
+ "The media and entertainment industry.",
+ "The retail industry.",
+ "The technology industry.",
+ "The travel industry."
+ ],
+ "description": "Industries the company can help with.",
+ "type": "array",
+ "items": {
+ "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"
+ }
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "websiteUrl": {
+ "description": "URL of the company's website.",
+ "type": "string"
+ },
+ "primaryAdwordsManagerAccountId": {
+ "description": "The Primary AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the company.",
+ "type": "string"
+ },
+ "localizedInfos": {
+ "description": "The list of localized info for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "LocalizedCompanyInfo"
+ }
+ },
+ "id": {
+ "description": "The ID of the company.",
+ "type": "string"
+ },
+ "certificationStatuses": {
+ "description": "The list of Google Partners certification statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationStatus"
+ }
+ },
+ "services": {
+ "description": "Services the company can help with.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "SERVICE_UNSPECIFIED",
+ "S_ADVANCED_ADWORDS_SUPPORT",
+ "S_ADVERTISING_ON_GOOGLE",
+ "S_AN_ENHANCED_WEBSITE",
+ "S_AN_ONLINE_MARKETING_PLAN",
+ "S_MOBILE_AND_VIDEO_ADS",
+ "S_MOBILE_WEBSITE_SERVICES"
+ ]
+ },
+ "enumDescriptions": [
+ "Unchosen.",
+ "Help with advanced AdWords support.",
+ "Help with advertising on Google.",
+ "Help with an enhanced website.",
+ "Help with an online marketing plan.",
+ "Help with mobile and video ads.",
+ "Help with mobile websites."
+ ]
+ },
+ "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"
+ },
+ "primaryLocation": {
+ "$ref": "Location",
+ "description": "The primary location of the company."
+ },
+ "ranks": {
+ "description": "Information related to the ranking of the company within the list of\ncompanies.",
+ "type": "array",
+ "items": {
+ "$ref": "Rank"
+ }
+ },
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
+ }
+ },
+ "badgeTier": {
+ "description": "Partner badge tier",
+ "type": "string",
+ "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"
+ ]
+ },
+ "companyTypes": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Handles all aspects of the advertising process.",
+ "Focuses solely on an advertiser's media placement.",
+ "Plans/executes advertising campaigns.",
+ "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.",
+ "Increases visibility in search engine result pages.",
+ "Drives promotional efforts for immediate impact.",
+ "Focuses on bid management, conversion, reporting.",
+ "Establishes favorable relationship with public through low/no-cost\ncommunications.",
+ "Does not manage other company's accounts, manages own marketing programs.",
+ "Full-service AdWords account management for local businesses."
+ ],
+ "description": "Company type labels listed on the company's profile.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "COMPANY_TYPE_UNSPECIFIED",
+ "FULL_SERVICE_AGENCY",
+ "MEDIA_AGENCY",
+ "CREATIVE_AGENCY",
+ "CDIGITAL_AGENCY",
+ "SEM_SEO",
+ "PERFORMANCE_MARKETING",
+ "ADVERTISING_TOOL_DEVELOPMENT",
+ "PR",
+ "SELF_MANAGED",
+ "RESELLER"
+ ]
+ }
+ },
+ "autoApprovalEmailDomains": {
+ "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "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"
+ },
+ "profileStatus": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Company profile does not show up publicly.",
+ "Company profile can only be viewed by the profile's URL\nand not by Google Partner Search.",
+ "Company profile can be viewed by the profile's URL\nand by Google Partner Search."
+ ],
+ "enum": [
+ "COMPANY_PROFILE_STATUS_UNSPECIFIED",
+ "HIDDEN",
+ "PUBLISHED",
+ "SEARCHABLE"
+ ],
+ "description": "The public viewability status of the company's profile.",
+ "type": "string"
+ },
+ "locations": {
+ "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.",
+ "type": "array",
+ "items": {
+ "$ref": "Location"
+ }
+ },
+ "convertedMinMonthlyBudget": {
+ "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code.",
+ "$ref": "Money"
+ }
+ },
+ "id": "Company"
+ },
+ "CreateLeadResponse": {
+ "description": "Response message for CreateLead.",
+ "type": "object",
+ "properties": {
+ "lead": {
+ "description": "Lead that was created depending on the outcome of\n\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e validation.",
+ "$ref": "Lead"
+ },
+ "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"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "CreateLeadResponse"
+ },
+ "GetCompanyResponse": {
+ "description": "Response message for GetCompany.",
+ "type": "object",
+ "properties": {
+ "company": {
+ "description": "The company.",
+ "$ref": "Company"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "GetCompanyResponse"
+ },
+ "Location": {
+ "description": "A location with address and geographic coordinates. May optionally contain a\ndetailed (multi-field) version of the address.",
+ "type": "object",
+ "properties": {
+ "administrativeArea": {
+ "description": "Top-level administrative subdivision of this country.",
+ "type": "string"
+ },
+ "locality": {
+ "description": "Generally refers to the city/town portion of an address.",
+ "type": "string"
+ },
+ "latLng": {
+ "$ref": "LatLng",
+ "description": "The latitude and longitude of the location, in degrees."
+ },
+ "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"
+ },
+ "sortingCode": {
+ "description": "Use of this code is very country-specific, but will refer to a secondary\nclassification code for sorting mail.",
+ "type": "string"
+ },
+ "languageCode": {
+ "description": "Language code of the address. Should be in BCP 47 format.",
+ "type": "string"
+ },
+ "addressLine": {
+ "description": "The following address lines represent the most specific part of any\naddress.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Location"
+ },
+ "ExamToken": {
+ "description": "A token that allows a user to take an exam.",
+ "type": "object",
+ "properties": {
+ "token": {
+ "description": "The token, only present if the user has access to the exam.",
+ "type": "string"
+ },
+ "examType": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ],
+ "description": "The type of the exam the token belongs to.",
+ "type": "string"
+ },
+ "examId": {
+ "description": "The id of the exam the token is for.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "ExamToken"
+ },
+ "CertificationExamStatus": {
+ "description": "Status for a Google Partners certification exam.",
+ "type": "object",
+ "properties": {
+ "numberUsersPass": {
+ "description": "The number of people who have passed the certification exam.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The type of certification exam.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ]
+ }
+ },
+ "id": "CertificationExamStatus"
+ },
+ "OptIns": {
+ "description": "A set of opt-ins for a user.",
+ "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"
+ },
+ "physicalMail": {
+ "description": "An opt-in to receive special promotional gifts and material in the mail.",
+ "type": "boolean"
+ },
+ "phoneContact": {
+ "description": "An opt-in to allow recieivng phone calls about their Partners account.",
+ "type": "boolean"
+ },
+ "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"
+ }
+ },
+ "id": "OptIns"
+ },
+ "Rank": {
+ "description": "Information related to ranking of results.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Total final score."
+ ],
+ "enum": [
+ "RANK_TYPE_UNSPECIFIED",
+ "RT_FINAL_SCORE"
+ ],
+ "description": "The type of rank.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The numerical value of the rank.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "Rank"
+ },
+ "GetPartnersStatusResponse": {
+ "description": "Response message for\nGetPartnersStatus.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "GetPartnersStatusResponse"
+ },
+ "UserProfile": {
+ "description": "The profile information of a Partners user.",
+ "type": "object",
+ "properties": {
+ "profilePublic": {
+ "description": "Whether the user's public profile is visible to anyone with the URL.",
+ "type": "boolean"
+ },
+ "channels": {
+ "description": "A list of ids representing which channels the user selected they were in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "jobFunctions": {
+ "description": "A list of ids represnting which job categories the user selected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "givenName": {
+ "description": "The user's given name.",
+ "type": "string"
+ },
+ "address": {
+ "$ref": "Location",
+ "description": "The user's mailing address, contains multiple fields."
+ },
+ "industries": {
+ "description": "A list of ids representing which industries the user selected.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "familyName": {
+ "description": "The user's family name.",
+ "type": "string"
+ },
+ "languages": {
+ "description": "The list of languages this user understands.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "emailOptIns": {
+ "$ref": "OptIns",
+ "description": "The list of opt-ins for the user, related to communication preferences."
+ },
+ "markets": {
+ "description": "A list of ids representing which markets the user was interested in.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "phoneNumber": {
+ "description": "The user's phone number.",
+ "type": "string"
+ },
+ "adwordsManagerAccount": {
+ "description": "If the user has edit access to multiple accounts, the user can choose the\npreferred account and it is used when a personal account is needed. Can\nbe empty.",
+ "format": "int64",
+ "type": "string"
+ },
+ "primaryCountryCode": {
+ "description": "The user's primary country, an ISO 2-character code.",
+ "type": "string"
+ },
+ "emailAddress": {
+ "description": "The email address the user has selected on the Partners site as primary.",
+ "type": "string"
+ }
+ },
+ "id": "UserProfile"
+ },
+ "HistoricalOffer": {
+ "description": "Historical information about a Google Partners Offer.",
+ "type": "object",
+ "properties": {
+ "adwordsUrl": {
+ "description": "Client's AdWords page URL.",
+ "type": "string"
+ },
+ "offerType": {
+ "description": "Type of offer.",
+ "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"
+ ]
+ },
+ "senderName": {
+ "description": "Name (First + Last) of the partners user to whom the incentive is allocated.",
+ "type": "string"
+ },
+ "offerCountryCode": {
+ "description": "Country Code for the offer country.",
+ "type": "string"
+ },
+ "expirationTime": {
+ "description": "Time this offer expires.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "offerCode": {
+ "description": "Offer code.",
+ "type": "string"
+ },
+ "creationTime": {
+ "description": "Time offer was first created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "clientEmail": {
+ "description": "Email address for client.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Status of the offer.",
+ "type": "string",
+ "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"
+ ]
+ },
+ "clientId": {
+ "description": "ID of client.",
+ "format": "int64",
+ "type": "string"
+ },
+ "clientName": {
+ "description": "Name of the client.",
+ "type": "string"
+ },
+ "lastModifiedTime": {
+ "description": "Time last action was taken.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "HistoricalOffer"
+ },
+ "UserOverrides": {
+ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.",
+ "type": "object",
+ "properties": {
+ "userId": {
+ "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ "type": "string"
+ },
+ "ipAddress": {
+ "description": "IP address to use instead of the user's geo-located IP address.",
+ "type": "string"
+ }
+ },
+ "id": "UserOverrides"
+ },
+ "LogUserEventRequest": {
+ "description": "Request message for\nLogUserEvent.",
+ "type": "object",
+ "properties": {
+ "eventCategory": {
+ "description": "The category the action belongs to.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Google Partner Search category.",
+ "Google Partner sign-up flow category.",
+ "Google Partner portal category.",
+ "Google Partner portal my-profile category.",
+ "Google Partner portal certifications category.",
+ "Google Partner portal community category.",
+ "Google Partner portal insights category.",
+ "Google Partner portal clients category.",
+ "Google Partner portal public user profile category.",
+ "Google Partner panel category.",
+ "Google Partner portal last admin dialog category.",
+ "Google Partner client category.",
+ "Google Partner portal company profile category.",
+ "External links category.",
+ "Google Partner landing category."
+ ],
+ "enum": [
+ "EVENT_CATEGORY_UNSPECIFIED",
+ "GOOGLE_PARTNER_SEARCH",
+ "GOOGLE_PARTNER_SIGNUP_FLOW",
+ "GOOGLE_PARTNER_PORTAL",
+ "GOOGLE_PARTNER_PORTAL_MY_PROFILE",
+ "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS",
+ "GOOGLE_PARTNER_PORTAL_COMMUNITY",
+ "GOOGLE_PARTNER_PORTAL_INSIGHTS",
+ "GOOGLE_PARTNER_PORTAL_CLIENTS",
+ "GOOGLE_PARTNER_PUBLIC_USER_PROFILE",
+ "GOOGLE_PARTNER_PANEL",
+ "GOOGLE_PARTNER_PORTAL_LAST_ADMIN_DIALOG",
+ "GOOGLE_PARTNER_CLIENT",
+ "GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE",
+ "EXTERNAL_LINKS",
+ "GOOGLE_PARTNER_LANDING"
+ ]
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "Advertiser lead information."
+ },
+ "eventAction": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser clicked `Find a partner` bottom button.",
+ "Advertiser clicked `Find a partner` top button.",
+ "Agency clicked `Join now` bottom button.",
+ "Agency clicked `Join now` top button.",
+ "Advertiser canceled partner contact form.",
+ "Advertiser started partner contact form.",
+ "Advertiser completed partner contact form.",
+ "Advertiser entered email in contact form.",
+ "Advertiser entered name in contact form.",
+ "Advertiser entered phone in contact form.",
+ "Advertiser failed \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nin contact form.",
+ "Company viewed by advertiser.",
+ "Advertiser canceled partner contact form on Google Partner Search.",
+ "Advertiser changed a top search parameter.",
+ "Advertiser started partner contact form on Google Partner Search.",
+ "Advertiser clicked `Show more partners` bottom button.",
+ "Advertiser completed partner contact form on Google Partner Search.",
+ "Advertiser saw no partners available with search criteria.",
+ "Advertiser performed search on Google Partner Search.",
+ "Advertiser viewed a partner on Google Partner Search.",
+ "Advertiser canceled partner contact form on profile page.",
+ "Advertiser started partner contact form on profile page.",
+ "Advertiser clicked partner website.",
+ "Advertiser completed contact form on profile page.",
+ "Advertiser viewed a partner profile.",
+ "Agency clicked `accept Terms Of Service` button.",
+ "Agency changed Terms Of Service country.",
+ "Agency added address in profile portal.",
+ "Agency added phone number in profile portal.",
+ "Agency changed primary account association.",
+ "Agency changed primary country association.",
+ "Agency clicked `affiliate` button in profile portal.",
+ "Agency clicked `give edit access` in profile portal.",
+ "Agency clicked `log out` in profile portal.",
+ "Agency clicked profile portal left nav.",
+ "Agency clicked `save and continue` at bottom of complete profile.",
+ "Agency clicked `unaffiliate` in profile portal.",
+ "Agency filled out company affiliation in profile portal.",
+ "Agency successfully connected with company in profile portal.",
+ "Agency clicked create MCC in profile portal.",
+ "Agency did not have an MCC associated on profile portal.",
+ "Agency had an MCC associated on profile portal.",
+ "Agency added job function in profile portal.",
+ "Agency looked at job function drop-down.",
+ "Agency selected `account manage` as job function.",
+ "Agency selected `account planner` as job function.",
+ "Agency selected `Analytics` as job function.",
+ "Agency selected `creative` as job function.",
+ "Agency selected `media buyer` as job function.",
+ "Agency selected `media planner` as job function.",
+ "Agency selected `other` as job function.",
+ "Agency selected `production` as job function.",
+ "Agency selected `SEO` as job function.",
+ "Agency selected `sales rep` as job function.",
+ "Agency selected `search specialist` as job function.",
+ "Agency added channels in profile portal.",
+ "Agency looked at `add channel` drop-down.",
+ "Agency selected `cross channel` from add channel drop-down.",
+ "Agency selected `display` from add channel drop-down.",
+ "Agency selected `mobile` from add channel drop-down.",
+ "Agency selected `search` from add channel drop-down.",
+ "Agency selected `social` from add channel drop-down.",
+ "Agency selected `tools` from add channel drop-down.",
+ "Agency selected `YouTube` from add channel drop-down.",
+ "Agency added industries in profile portal.",
+ "Agency changed `add industries` drop-down.",
+ "Agency added markets in profile portal.",
+ "Agency changed `add markets` drop-down.",
+ "Agency checked `recieve mail promotions` in profile portal.",
+ "Agency checked `recieve mail promotions` in sign-up.",
+ "Agency selected `opt-in beta tests and market research`.",
+ "Agency selected `opt-in beta tests` in profile portal.",
+ "Agency selected `opt-in news` in profile portal.",
+ "Agency selected `opt-in news invitations and promotions`.",
+ "Agency selected `opt-in performance SUG` in profile portal.",
+ "Agency selected `opt-in performance suggestions`.",
+ "Agency selected `opt-in select all email notifications`.",
+ "Agency selected `select all opt-ins` in profile portal.",
+ "Agency clicked back button on `connect with company`.",
+ "Agency clicked continue to overview on `connect with company`.",
+ "Agency clicked `create MCC connect with company not found`.",
+ "Agency clicked `give edit access connect with company not found`.",
+ "Agency clicked `log out connect with company not found`.",
+ "Agency clicked `skip for now on connect with company page`.",
+ "Agency closed connection to company.",
+ "Agency completed field connect with company.",
+ "Agency found company to connect with.",
+ "Agency successfully created company.",
+ "Agency added new company location.",
+ "Agency clicked community `join now link` in portal notifications.",
+ "Agency clicked `connect to company` link in portal notifications.",
+ "Agency cliecked `get certified` link in portal notifications.",
+ "Agency clicked `get VideoAds certified` link in portal notifications.",
+ "Agency clicked `link to MCC` link in portal notifications.",
+ "Agency clicked `insight content` in portal.",
+ "Agency clicked `insights view now pitch decks` in portal.",
+ "Agency clicked `insights` left nav in portal.",
+ "Agency clicked `insights upload content`.",
+ "Agency clicked `insights viewed deprecated`.",
+ "Agency clicked `community` left nav in portal.",
+ "Agency clicked `join community` button in community portal.",
+ "Agency clicked `certifications` left nav in portal.",
+ "Agency clicked `certifications product` left nav in portal.",
+ "Agency clicked `partner status` left nav in portal.",
+ "Agency clicked `partner status product` left nav in portal.",
+ "Agency clicked `offers` left nav in portal.",
+ "Agency clicked `send` button on offers page.",
+ "Agency clicked `exam details` on certifications AdWords page.",
+ "Agency clicked `see exams` certifications main page.",
+ "Agency clicked `take exam` on certifications exam page.",
+ "Agency opened `last admin` dialog.",
+ "Agency opened dialog with no users.",
+ "Agency promoted user to admin.",
+ "Agency unaffiliated.",
+ "Agency changed roles.",
+ "Advertiser clicked `company name` link to profile.",
+ "Advertiser viewed AdWords certificate.",
+ "Advertiser viewed AdWords Search certificate.",
+ "Advertiser viewed AdWords Display certificate.",
+ "Advertiser clicked AdWords certificate help icon.",
+ "Advertiser viewed Analytics certificate.",
+ "Advertiser viewed DoubleClick certificate.",
+ "Advertiser viewed VideoAds certificate.",
+ "Advertiser clicked Shopping certificate help icon.",
+ "Advertiser clicked VideoAds certificate help icon.",
+ "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",
+ "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP",
+ "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM",
+ "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM",
+ "SMB_CLICKED_CONTACT_A_PARTNER",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM",
+ "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM",
+ "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM",
+ "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM",
+ "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM",
+ "PARTNER_VIEWED_BY_SMB",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS",
+ "SMB_CHANGED_A_SEARCH_PARAMETER_TOP",
+ "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS",
+ "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS",
+ "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA",
+ "SMB_PERFORMED_SEARCH_ON_GPS",
+ "SMB_VIEWED_A_PARTNER_ON_GPS",
+ "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
+ "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE",
+ "SMB_CLICKED_PARTNER_WEBSITE",
+ "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE",
+ "SMB_VIEWED_A_PARTNER_PROFILE",
+ "AGENCY_CLICKED_ACCEPT_TOS_BUTTON",
+ "AGENCY_CHANGED_TOS_COUNTRY",
+ "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION",
+ "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION",
+ "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL",
+ "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE",
+ "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL",
+ "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE",
+ "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL",
+ "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
+ "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE",
+ "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL",
+ "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN",
+ "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION",
+ "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION",
+ "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN",
+ "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL",
+ "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL",
+ "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN",
+ "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN",
+ "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE",
+ "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP",
+ "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
+ "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
+ "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL",
+ "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
+ "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS",
+ "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL",
+ "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY",
+ "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY",
+ "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGECNY_CLICKED_LOG_OUT_CONNECT_WITH_COMPANY_NOT_FOUND",
+ "AGENCY_CLICKED_SKIP_FOR_NOW_ON_CONNECT_WITH_COMPANY_PAGE",
+ "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY",
+ "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY",
+ "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH",
+ "AGENCY_SUCCESSFULLY_CREATED_COMPANY",
+ "AGENCY_ADDED_NEW_COMPANY_LOCATION",
+ "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_GET_VIDEO_ADS_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS",
+ "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT",
+ "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED",
+ "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL",
+ "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL",
+ "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE",
+ "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE",
+ "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE",
+ "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE",
+ "AGENCY_OPENED_LAST_ADMIN_DIALOG",
+ "AGENCY_OPENED_DIALOG_WITH_NO_USERS",
+ "AGENCY_PROMOTED_USER_TO_ADMIN",
+ "AGENCY_UNAFFILIATED",
+ "AGENCY_CHANGED_ROLES",
+ "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE",
+ "SMB_VIEWED_ADWORDS_CERTIFICATE",
+ "SMB_VIEWED_ADWORDS_SEARCH_CERTIFICATE",
+ "SMB_VIEWED_ADWORDS_DISPLAY_CERTIFICATE",
+ "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON",
+ "SMB_VIEWED_ANALYTICS_CERTIFICATE",
+ "SMB_VIEWED_DOUBLECLICK_CERTIFICATE",
+ "SMB_VIEWED_VIDEO_ADS_CERTIFICATE",
+ "SMB_VIEWED_SHOPPING_CERTIFICATE",
+ "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON",
+ "CLICKED_HELP_AT_BOTTOM",
+ "CLICKED_HELP_AT_TOP",
+ "CLIENT_ERROR",
+ "AGENCY_CLICKED_LEFT_NAV_STORIES",
+ "CLICKED",
+ "SMB_VIEWED_MOBILE_CERTIFICATE",
+ "AGENCY_FAILED_COMPANY_VERIFICATION",
+ "VISITED_LANDING",
+ "VISITED_GPS",
+ "VISITED_AGENCY_PORTAL",
+ "CANCELLED_INDIVIDUAL_SIGN_UP",
+ "CANCELLED_COMPANY_SIGN_UP",
+ "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP",
+ "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE",
+ "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS",
+ "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH",
+ "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS",
+ "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS",
+ "AGENCY_LINKED_INDIVIDUAL_MCC",
+ "AGENCY_SUGGESTED_TO_USER",
+ "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED",
+ "AGENCY_PICKED_SUGGESTED_AGENCY",
+ "AGENCY_SEARCHED_FOR_AGENCIES",
+ "AGENCY_PICKED_SEARCHED_AGENCY",
+ "AGENCY_DISMISSED_AFFILIATION_WIDGET",
+ "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT",
+ "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT",
+ "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON",
+ "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM"
+ ],
+ "description": "The action that occurred.",
+ "type": "string"
+ },
+ "requestMetadata": {
+ "description": "Current request metadata.",
+ "$ref": "RequestMetadata"
+ },
+ "url": {
+ "description": "The URL where the event occurred.",
+ "type": "string"
+ },
+ "eventDatas": {
+ "description": "List of event data for the event.",
+ "type": "array",
+ "items": {
+ "$ref": "EventData"
+ }
+ },
+ "eventScope": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Based on visitor.",
+ "Based on session.",
+ "Based on page visit."
+ ],
+ "enum": [
+ "EVENT_SCOPE_UNSPECIFIED",
+ "VISITOR",
+ "SESSION",
+ "PAGE"
+ ],
+ "description": "The scope of the event.",
+ "type": "string"
+ }
+ },
+ "id": "LogUserEventRequest"
+ },
+ "AnalyticsDataPoint": {
+ "description": "Details of the analytics events for a `Company` within a single day.",
+ "type": "object",
+ "properties": {
+ "eventCount": {
+ "description": "Number of times the type of event occurred.\nMeaning depends on context (e.g. profile views, contacts, etc.).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "eventLocations": {
+ "description": "Location information of where these events occurred.",
+ "type": "array",
+ "items": {
+ "$ref": "LatLng"
+ }
+ }
+ },
+ "id": "AnalyticsDataPoint"
+ },
+ "Analytics": {
+ "description": "Analytics data for a `Company` within a single day.",
+ "type": "object",
+ "properties": {
+ "eventDate": {
+ "description": "Date on which these events occurred.",
+ "$ref": "Date"
+ },
+ "profileViews": {
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users viewing the `Company` profile\non the specified date."
+ },
+ "searchViews": {
+ "$ref": "AnalyticsDataPoint",
+ "description": "Instances of users seeing the `Company` in Google Partners Search results\non the specified date."
+ },
+ "contacts": {
+ "description": "Instances of users contacting the `Company`\non the specified date.",
+ "$ref": "AnalyticsDataPoint"
+ }
+ },
+ "id": "Analytics"
+ },
+ "AdWordsManagerAccountInfo": {
+ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "The AdWords Manager Account id.",
+ "format": "int64",
+ "type": "string"
+ },
+ "customerName": {
+ "description": "Name of the customer this account represents.",
+ "type": "string"
+ }
+ },
+ "id": "AdWordsManagerAccountInfo"
+ },
+ "PublicProfile": {
+ "description": "Basic information from a public profile.",
+ "type": "object",
+ "properties": {
+ "displayName": {
+ "description": "The display name of the public profile.",
+ "type": "string"
+ },
+ "displayImageUrl": {
+ "description": "The URL to the main display image of the public profile. Being deprecated.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The ID which can be used to retrieve more details about the public profile.",
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL of the public profile.",
+ "type": "string"
+ },
+ "profileImage": {
+ "description": "The URL to the main profile image of the public profile.",
+ "type": "string"
+ }
+ },
+ "id": "PublicProfile"
+ },
+ "ResponseMetadata": {
+ "description": "Common data that is in each API response.",
+ "type": "object",
+ "properties": {
+ "debugInfo": {
+ "description": "Debug information about this request.",
+ "$ref": "DebugInfo"
+ }
+ },
+ "id": "ResponseMetadata"
+ },
+ "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"
+ }
+ },
+ "id": "RecaptchaChallenge"
+ },
+ "AvailableOffer": {
+ "description": "Available Offers to be distributed.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "ID of this offer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "qualifiedCustomersComplete": {
+ "description": "Whether or not the list of qualified customers is definitely complete.",
+ "type": "boolean"
+ },
+ "countryOfferInfos": {
+ "description": "Offer info by country.",
+ "type": "array",
+ "items": {
+ "$ref": "CountryOfferInfo"
+ }
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer.",
+ "type": "string"
+ },
+ "maxAccountAge": {
+ "description": "The maximum age of an account [in days] to be eligible.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "qualifiedCustomer": {
+ "description": "Customers who qualify for this offer.",
+ "type": "array",
+ "items": {
+ "$ref": "OfferCustomer"
+ }
+ },
+ "terms": {
+ "description": "Terms of the offer.",
+ "type": "string"
+ },
+ "showSpecialOfferCopy": {
+ "description": "Should special text be shown on the offers page.",
+ "type": "boolean"
+ },
+ "available": {
+ "description": "The number of codes for this offer that are available for distribution.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "description": "Description of the offer.",
+ "type": "string"
+ },
+ "offerLevel": {
+ "description": "Level of this offer.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unset.",
+ "Users/Agencies that have no offers because of a problem.",
+ "Users/Agencies that have no offers due to contractural agreements.",
+ "Users/Agencies that have a manually-configured limit.",
+ "Some Agencies don't get any offers.",
+ "Basic level gets 5 per month.",
+ "Agencies with adequate AHI and spend get 15/month.",
+ "Badged partners (even in grace) get 50 per month."
+ ],
+ "enum": [
+ "OFFER_LEVEL_UNSPECIFIED",
+ "OFFER_LEVEL_DENY_PROBLEM",
+ "OFFER_LEVEL_DENY_CONTRACT",
+ "OFFER_LEVEL_MANUAL",
+ "OFFER_LEVEL_LIMIT_0",
+ "OFFER_LEVEL_LIMIT_5",
+ "OFFER_LEVEL_LIMIT_15",
+ "OFFER_LEVEL_LIMIT_50"
+ ]
+ },
+ "name": {
+ "description": "Name of the offer.",
+ "type": "string"
+ }
+ },
+ "id": "AvailableOffer"
+ },
+ "LatLng": {
+ "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\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)\n\nThe code in logs/storage/validator/logs_validator_traits.cc treats this type\nas if it were annotated as ST_LOCATION.",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "format": "double",
+ "type": "number"
+ },
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "id": "LatLng"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object",
+ "properties": {
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "Money"
+ },
+ "AnalyticsSummary": {
+ "description": "Analytics aggregated data for a `Company` for a given date range.",
+ "type": "object",
+ "properties": {
+ "contactsCount": {
+ "description": "Aggregated number of times users contacted the `Company`\nfor given date range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "profileViewsCount": {
+ "description": "Aggregated number of profile views for the `Company` for given date range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "searchViewsCount": {
+ "description": "Aggregated number of times users saw the `Company`\nin Google Partners Search results for given date range.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "AnalyticsSummary"
+ },
+ "LogMessageRequest": {
+ "description": "Request message for\nLogClientMessage.",
+ "type": "object",
+ "properties": {
+ "level": {
+ "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."
+ ],
+ "enum": [
+ "MESSAGE_LEVEL_UNSPECIFIED",
+ "ML_FINE",
+ "ML_INFO",
+ "ML_WARNING",
+ "ML_SEVERE"
+ ]
+ },
+ "details": {
+ "description": "Details about the client message.",
+ "type": "string"
+ },
+ "clientInfo": {
+ "description": "Map of client info, such as URL, browser navigator, browser platform, etc.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ }
+ },
+ "id": "LogMessageRequest"
+ },
+ "Lead": {
+ "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).",
+ "type": "object",
+ "properties": {
+ "familyName": {
+ "description": "Last name of lead source.",
+ "type": "string"
+ },
+ "comments": {
+ "description": "Comments lead source gave.",
+ "type": "string"
+ },
+ "id": {
+ "description": "ID of the lead.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "Phone number of lead source.",
+ "type": "string"
+ },
+ "adwordsCustomerId": {
+ "description": "The AdWords Customer ID of the lead.",
+ "format": "int64",
+ "type": "string"
+ },
+ "createTime": {
+ "description": "Timestamp of when this lead was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "marketingOptIn": {
+ "description": "Whether or not the lead signed up for marketing emails",
+ "type": "boolean"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Google Partner Search."
+ ],
+ "enum": [
+ "LEAD_TYPE_UNSPECIFIED",
+ "LT_GPS"
+ ],
+ "description": "Type of lead.",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "First name of lead source.",
+ "type": "string"
+ },
+ "minMonthlyBudget": {
+ "$ref": "Money",
+ "description": "The minimum monthly budget lead source is willing to spend."
+ },
+ "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": {
+ "description": "The lead's state in relation to the company.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unchosen.",
+ "Lead not yet contacted.",
+ "Lead has been contacted.",
+ "Lead has become a client.",
+ "Lead in a state not covered by other options."
+ ],
+ "enum": [
+ "LEAD_STATE_UNSPECIFIED",
+ "LEAD",
+ "CONTACTED",
+ "CLIENT",
+ "OTHER"
+ ]
+ },
+ "gpsMotivations": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Advertiser needs help with their advertising.",
+ "Advertiser needs help with their website.",
+ "Advertiser does not have a website."
+ ],
+ "description": "List of reasons for using Google Partner Search and creating a lead.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "GPS_MOTIVATION_UNSPECIFIED",
+ "GPSM_HELP_WITH_ADVERTISING",
+ "GPSM_HELP_WITH_WEBSITE",
+ "GPSM_NO_WEBSITE"
+ ]
+ }
+ },
+ "email": {
+ "description": "Email address of lead source.",
+ "type": "string"
+ }
+ },
+ "id": "Lead"
+ },
+ "DebugInfo": {
+ "description": "Debug information about this request.",
+ "type": "object",
+ "properties": {
+ "serviceUrl": {
+ "description": "URL of the service that handled this request.",
+ "type": "string"
+ },
+ "serverInfo": {
+ "description": "Info about the server that serviced this request.",
+ "type": "string"
+ },
+ "serverTraceInfo": {
+ "description": "Server-side debug stack trace.",
+ "type": "string"
+ }
+ },
+ "id": "DebugInfo"
+ },
+ "ListUserStatesResponse": {
+ "description": "Response message for\nListUserStates.",
+ "type": "object",
+ "properties": {
+ "userStates": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search."
+ ],
+ "description": "User's states.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "USER_STATE_UNSPECIFIED",
+ "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT"
+ ],
+ "type": "string"
+ }
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "ListUserStatesResponse"
+ },
+ "CompanyRelation": {
+ "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.",
+ "type": "object",
+ "properties": {
+ "companyAdmin": {
+ "description": "Indicates if the user is an admin for this company.",
+ "type": "boolean"
+ },
+ "address": {
+ "description": "The primary address for this company.",
+ "type": "string"
+ },
+ "isPending": {
+ "description": "The flag that indicates if the company is pending verification.",
+ "type": "boolean"
+ },
+ "creationTime": {
+ "description": "The timestamp of when affiliation was requested.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state of relationship, in terms of approvals.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default unspecified value.",
+ "User has filled in a request to be associated with an company.\nNow waiting email confirmation.",
+ "Pending approval from company.\nEmail confirmation will not approve this one.",
+ "Approved by company."
+ ],
+ "enum": [
+ "USER_COMPANY_REATION_STATE_NONE_SPECIFIED",
+ "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL",
+ "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN",
+ "USER_COMPANY_RELATION_STATE_APPROVED"
+ ]
+ },
+ "name": {
+ "description": "The name (in the company's primary language) for the company.",
+ "type": "string"
+ },
+ "managerAccount": {
+ "description": "The AdWords manager account # associated this company.",
+ "format": "int64",
+ "type": "string"
+ },
+ "segment": {
+ "description": "The segment the company is classified as.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "COMPANY_SEGMENT_UNKNOWN",
+ "COMPANY_SEGMENT_NAL",
+ "COMPANY_SEGMENT_PSP",
+ "COMPANY_SEGMENT_PPSP"
+ ]
+ },
+ "enumDescriptions": [
+ "Default segment indicates an unknown.",
+ "Segment representing a selected group of Partners",
+ "Segment representing Premier SMB Partners, an AdWords partnership program.",
+ "A segment of Premier SMB Partners that have relationship with Google."
+ ]
+ },
+ "specializationStatus": {
+ "description": "The list of Google Partners specialization statuses for the company.",
+ "type": "array",
+ "items": {
+ "$ref": "SpecializationStatus"
+ }
+ },
+ "badgeTier": {
+ "enumDescriptions": [
+ "Tier badge is not set.",
+ "Agency has regular partner badge.",
+ "Agency has premier badge."
+ ],
+ "enum": [
+ "BADGE_TIER_NONE",
+ "BADGE_TIER_REGULAR",
+ "BADGE_TIER_PREMIER"
+ ],
+ "description": "Whether the company is a Partner.",
+ "type": "string"
+ },
+ "phoneNumber": {
+ "description": "The phone number for the company's primary address.",
+ "type": "string"
+ },
+ "website": {
+ "description": "The website URL for this company.",
+ "type": "string"
+ },
+ "companyId": {
+ "description": "The ID of the company. There may be no id if this is a\npending company.5",
+ "type": "string"
+ },
+ "logoUrl": {
+ "description": "A URL to a profile photo, e.g. a G+ profile photo.",
+ "type": "string"
+ },
+ "resolvedTimestamp": {
+ "description": "The timestamp when the user was approved.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "CompanyRelation"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "TrafficSource": {
+ "description": "Source of traffic for the current request.",
+ "type": "object",
+ "properties": {
+ "trafficSourceId": {
+ "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ },
+ "trafficSubId": {
+ "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.",
+ "type": "string"
+ }
+ },
+ "id": "TrafficSource"
+ },
+ "RequestMetadata": {
+ "description": "Common data that is in each API request.",
+ "type": "object",
+ "properties": {
+ "userOverrides": {
+ "$ref": "UserOverrides",
+ "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products."
+ },
+ "partnersSessionId": {
+ "description": "Google Partners session ID.",
+ "type": "string"
+ },
+ "experimentIds": {
+ "description": "Experiment IDs the current request belongs to.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "trafficSource": {
+ "description": "Source of traffic for the current request.",
+ "$ref": "TrafficSource"
+ },
+ "locale": {
+ "description": "Locale to use for the current request.",
+ "type": "string"
+ }
+ },
+ "id": "RequestMetadata"
+ },
+ "CreateLeadRequest": {
+ "description": "Request message for CreateLead.",
+ "type": "object",
+ "properties": {
+ "requestMetadata": {
+ "$ref": "RequestMetadata",
+ "description": "Current request metadata."
+ },
+ "lead": {
+ "$ref": "Lead",
+ "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided."
+ },
+ "recaptchaChallenge": {
+ "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.",
+ "$ref": "RecaptchaChallenge"
+ }
+ },
+ "id": "CreateLeadRequest"
+ },
+ "EventData": {
+ "description": "Key value data pair for an event.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "Data values.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "key": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Action data.",
+ "Agency ID data.",
+ "Agency name data.",
+ "Agency phone number data.",
+ "Agency website data.",
+ "Budget data.",
+ "Center-point data.",
+ "Certification data.",
+ "Comment data.",
+ "Country data.",
+ "Currency data.",
+ "Currently viewed agency ID data.",
+ "Distance data.",
+ "Distance type data.",
+ "Exam data.",
+ "History token data.",
+ "Identifier data.",
+ "Industry data.",
+ "Insight tag data.",
+ "Language data.",
+ "Location data.",
+ "Marketing opt-in data.",
+ "Query data.",
+ "Search start index data.",
+ "Service data.",
+ "Show vow data.",
+ "Solution data.",
+ "Traffic source ID data.",
+ "Traffic sub ID data.",
+ "Viewport data.",
+ "Website data.",
+ "Details data.",
+ "Experiment ID data.",
+ "Google Partner Search motivation data.",
+ "URL data.",
+ "Element we wanted user to focus on.",
+ "Progress when viewing an item \\[0-100\\]."
+ ],
+ "enum": [
+ "EVENT_DATA_TYPE_UNSPECIFIED",
+ "ACTION",
+ "AGENCY_ID",
+ "AGENCY_NAME",
+ "AGENCY_PHONE_NUMBER",
+ "AGENCY_WEBSITE",
+ "BUDGET",
+ "CENTER_POINT",
+ "CERTIFICATION",
+ "COMMENT",
+ "COUNTRY",
+ "CURRENCY",
+ "CURRENTLY_VIEWED_AGENCY_ID",
+ "DISTANCE",
+ "DISTANCE_TYPE",
+ "EXAM",
+ "HISTORY_TOKEN",
+ "ID",
+ "INDUSTRY",
+ "INSIGHT_TAG",
+ "LANGUAGE",
+ "LOCATION",
+ "MARKETING_OPT_IN",
+ "QUERY",
+ "SEARCH_START_INDEX",
+ "SERVICE",
+ "SHOW_VOW",
+ "SOLUTION",
+ "TRAFFIC_SOURCE_ID",
+ "TRAFFIC_SUB_ID",
+ "VIEW_PORT",
+ "WEBSITE",
+ "DETAILS",
+ "EXPERIMENT_ID",
+ "GPS_MOTIVATION",
+ "URL",
+ "ELEMENT_FOCUS",
+ "PROGRESS"
+ ],
+ "description": "Data type.",
+ "type": "string"
+ }
+ },
+ "id": "EventData"
+ },
+ "ExamStatus": {
+ "description": "A user's information on a specific exam.",
+ "type": "object",
+ "properties": {
+ "passed": {
+ "description": "Whether this exam has been passed and not expired.",
+ "type": "boolean"
+ },
+ "taken": {
+ "description": "The date the user last taken this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "warning": {
+ "description": "Whether this exam is in the state of warning.",
+ "type": "boolean"
+ },
+ "expiration": {
+ "description": "Date this exam is due to expire.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "lastPassed": {
+ "description": "The date the user last passed this exam.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "examType": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "Adwords Fundamentals exam.",
+ "AdWords advanced search exam.",
+ "AdWords advanced display exam.",
+ "VideoAds exam.",
+ "DoubleClick exam.",
+ "Analytics exam.",
+ "Shopping exam.",
+ "Mobile exam.",
+ "Digital Sales exam.",
+ "Mobile Sites exam."
+ ],
+ "enum": [
+ "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ "CET_ADWORDS_FUNDAMENTALS",
+ "CET_ADWORDS_ADVANCED_SEARCH",
+ "CET_ADWORDS_ADVANCED_DISPLAY",
+ "CET_VIDEO_ADS",
+ "CET_DOUBLECLICK",
+ "CET_ANALYTICS",
+ "CET_SHOPPING",
+ "CET_MOBILE",
+ "CET_DIGITAL_SALES",
+ "CET_MOBILE_SITES"
+ ],
+ "description": "The type of the exam.",
+ "type": "string"
+ }
+ },
+ "id": "ExamStatus"
+ },
+ "ListOffersResponse": {
+ "description": "Response for ListOffer.",
+ "type": "object",
+ "properties": {
+ "noOfferReason": {
+ "enumDescriptions": [
+ "Unset.",
+ "Not an MCC.",
+ "Offer limit has been reached.",
+ "Ineligible for offers."
+ ],
+ "enum": [
+ "NO_OFFER_REASON_UNSPECIFIED",
+ "NO_OFFER_REASON_NO_MCC",
+ "NO_OFFER_REASON_LIMIT_REACHED",
+ "NO_OFFER_REASON_INELIGIBLE"
+ ],
+ "description": "Reason why no Offers are available.",
+ "type": "string"
+ },
+ "availableOffers": {
+ "description": "Available Offers to be distributed.",
+ "type": "array",
+ "items": {
+ "$ref": "AvailableOffer"
+ }
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "ListOffersResponse"
+ },
+ "CountryOfferInfo": {
+ "description": "Offer info by country.",
+ "type": "object",
+ "properties": {
+ "offerCountryCode": {
+ "description": "Country code for which offer codes may be requested.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "(localized) Spend X amount for that country's offer.",
+ "type": "string"
+ },
+ "offerType": {
+ "enumDescriptions": [
+ "Unset.",
+ "AdWords spend X get Y.",
+ "Youtube video.",
+ "Spend Match up to Y."
+ ],
+ "enum": [
+ "OFFER_TYPE_UNSPECIFIED",
+ "OFFER_TYPE_SPEND_X_GET_Y",
+ "OFFER_TYPE_VIDEO",
+ "OFFER_TYPE_SPEND_MATCH"
+ ],
+ "description": "Type of offer country is eligible for.",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "(localized) Get Y amount for that country's offer.",
+ "type": "string"
+ }
+ },
+ "id": "CountryOfferInfo"
+ },
+ "ListCompaniesResponse": {
+ "description": "Response message for\nListCompanies.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ },
+ "companies": {
+ "description": "The list of companies.",
+ "type": "array",
+ "items": {
+ "$ref": "Company"
+ }
+ }
+ },
+ "id": "ListCompaniesResponse"
+ },
+ "OfferCustomer": {
+ "description": "Customers qualified for an offer.",
+ "type": "object",
+ "properties": {
+ "adwordsUrl": {
+ "description": "URL to the customer's AdWords page.",
+ "type": "string"
+ },
+ "eligibilityDaysLeft": {
+ "description": "Days the customer is still eligible.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "countryCode": {
+ "description": "Country code of the customer.",
+ "type": "string"
+ },
+ "externalCid": {
+ "description": "External CID for the customer.",
+ "format": "int64",
+ "type": "string"
+ },
+ "offerType": {
+ "description": "Type of the offer",
+ "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"
+ ]
+ },
+ "creationTime": {
+ "description": "Time the customer was created.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "getYAmount": {
+ "description": "Formatted Get Y amount with currency code.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the customer.",
+ "type": "string"
+ },
+ "spendXAmount": {
+ "description": "Formatted Spend X amount with currency code.",
+ "type": "string"
+ }
+ },
+ "id": "OfferCustomer"
+ },
+ "CertificationStatus": {
+ "description": "Google Partners certification status.",
+ "type": "object",
+ "properties": {
+ "isCertified": {
+ "description": "Whether certification is passing.",
+ "type": "boolean"
+ },
+ "examStatuses": {
+ "description": "List of certification exam statuses.",
+ "type": "array",
+ "items": {
+ "$ref": "CertificationExamStatus"
+ }
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unchosen.",
+ "AdWords certified.",
+ "YouTube certified.",
+ "VideoAds certified.",
+ "Analytics certified.",
+ "DoubleClick certified.",
+ "Shopping certified.",
+ "Mobile certified.",
+ "Digital sales certified.",
+ "AdWords Search certified.",
+ "AdWords Display certified.",
+ "Mobile Sites certified."
+ ],
+ "enum": [
+ "CERTIFICATION_TYPE_UNSPECIFIED",
+ "CT_ADWORDS",
+ "CT_YOUTUBE",
+ "CT_VIDEOADS",
+ "CT_ANALYTICS",
+ "CT_DOUBLECLICK",
+ "CT_SHOPPING",
+ "CT_MOBILE",
+ "CT_DIGITAL_SALES",
+ "CT_ADWORDS_SEARCH",
+ "CT_ADWORDS_DISPLAY",
+ "CT_MOBILE_SITES"
+ ],
+ "description": "The type of the certification.",
+ "type": "string"
+ },
+ "userCount": {
+ "description": "Number of people who are certified,",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "CertificationStatus"
+ },
+ "LocalizedCompanyInfo": {
+ "description": "The localized company information.",
+ "type": "object",
+ "properties": {
+ "languageCode": {
+ "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").",
+ "type": "string"
+ },
+ "countryCodes": {
+ "description": "List of country codes for the localized company info.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "overview": {
+ "description": "Localized brief description that the company uses to advertise themselves.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Localized display name.",
+ "type": "string"
+ }
+ },
+ "id": "LocalizedCompanyInfo"
+ },
+ "LogUserEventResponse": {
+ "description": "Response message for\nLogUserEvent.",
+ "type": "object",
+ "properties": {
+ "responseMetadata": {
+ "description": "Current response metadata.",
+ "$ref": "ResponseMetadata"
+ }
+ },
+ "id": "LogUserEventResponse"
+ },
+ "ListOffersHistoryResponse": {
+ "description": "Response for ListOfferHistory.",
+ "type": "object",
+ "properties": {
+ "canShowEntireCompany": {
+ "description": "True if the user has the option to show entire company history.",
+ "type": "boolean"
+ },
+ "totalResults": {
+ "description": "Number of results across all pages.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "showingEntireCompany": {
+ "description": "True if this response is showing entire company history.",
+ "type": "boolean"
+ },
+ "offers": {
+ "description": "Historical offers meeting request.",
+ "type": "array",
+ "items": {
+ "$ref": "HistoricalOffer"
+ }
+ },
+ "nextPageToken": {
+ "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.",
+ "type": "string"
+ },
+ "responseMetadata": {
+ "$ref": "ResponseMetadata",
+ "description": "Current response metadata."
+ }
+ },
+ "id": "ListOffersHistoryResponse"
+ }
+ },
+ "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": "v2"
}
diff --git a/partners/v2/partners-gen.go b/partners/v2/partners-gen.go
index 6ade605..fedfbe2 100644
--- a/partners/v2/partners-gen.go
+++ b/partners/v2/partners-gen.go
@@ -50,10 +50,16 @@
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
+ s.Analytics = NewAnalyticsService(s)
s.ClientMessages = NewClientMessagesService(s)
s.Companies = NewCompaniesService(s)
+ s.Exams = NewExamsService(s)
+ s.Leads = NewLeadsService(s)
+ s.Offers = NewOffersService(s)
s.UserEvents = NewUserEventsService(s)
s.UserStates = NewUserStatesService(s)
+ s.Users = NewUsersService(s)
+ s.V2 = NewV2Service(s)
return s, nil
}
@@ -63,13 +69,25 @@
UserAgent string // optional additional User-Agent fragment
GoogleClientHeaderElement string // client header fragment, for Google use only
+ Analytics *AnalyticsService
+
ClientMessages *ClientMessagesService
Companies *CompaniesService
+ Exams *ExamsService
+
+ Leads *LeadsService
+
+ Offers *OffersService
+
UserEvents *UserEventsService
UserStates *UserStatesService
+
+ Users *UsersService
+
+ V2 *V2Service
}
func (s *Service) userAgent() string {
@@ -83,6 +101,15 @@
return gensupport.GoogleClientHeader("20170210", s.GoogleClientHeaderElement)
}
+func NewAnalyticsService(s *Service) *AnalyticsService {
+ rs := &AnalyticsService{s: s}
+ return rs
+}
+
+type AnalyticsService struct {
+ s *Service
+}
+
func NewClientMessagesService(s *Service) *ClientMessagesService {
rs := &ClientMessagesService{s: s}
return rs
@@ -113,6 +140,45 @@
s *Service
}
+func NewExamsService(s *Service) *ExamsService {
+ rs := &ExamsService{s: s}
+ return rs
+}
+
+type ExamsService struct {
+ s *Service
+}
+
+func NewLeadsService(s *Service) *LeadsService {
+ rs := &LeadsService{s: s}
+ return rs
+}
+
+type LeadsService struct {
+ s *Service
+}
+
+func NewOffersService(s *Service) *OffersService {
+ rs := &OffersService{s: s}
+ rs.History = NewOffersHistoryService(s)
+ return rs
+}
+
+type OffersService struct {
+ s *Service
+
+ History *OffersHistoryService
+}
+
+func NewOffersHistoryService(s *Service) *OffersHistoryService {
+ rs := &OffersHistoryService{s: s}
+ return rs
+}
+
+type OffersHistoryService struct {
+ s *Service
+}
+
func NewUserEventsService(s *Service) *UserEventsService {
rs := &UserEventsService{s: s}
return rs
@@ -131,6 +197,311 @@
s *Service
}
+func NewUsersService(s *Service) *UsersService {
+ rs := &UsersService{s: s}
+ return rs
+}
+
+type UsersService struct {
+ s *Service
+}
+
+func NewV2Service(s *Service) *V2Service {
+ rs := &V2Service{s: s}
+ return rs
+}
+
+type V2Service struct {
+ s *Service
+}
+
+// AdWordsManagerAccountInfo: Information about a particular AdWords
+// Manager Account.
+// Read more at https://support.google.com/adwords/answer/6139186
+type AdWordsManagerAccountInfo struct {
+ // CustomerName: Name of the customer this account represents.
+ CustomerName string `json:"customerName,omitempty"`
+
+ // Id: The AdWords Manager Account id.
+ Id int64 `json:"id,omitempty,string"`
+
+ // ForceSendFields is a list of field names (e.g. "CustomerName") 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. "CustomerName") 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 *AdWordsManagerAccountInfo) MarshalJSON() ([]byte, error) {
+ type noMethod AdWordsManagerAccountInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Analytics: Analytics data for a `Company` within a single day.
+type Analytics struct {
+ // Contacts: Instances of users contacting the `Company`
+ // on the specified date.
+ Contacts *AnalyticsDataPoint `json:"contacts,omitempty"`
+
+ // EventDate: Date on which these events occurred.
+ EventDate *Date `json:"eventDate,omitempty"`
+
+ // ProfileViews: Instances of users viewing the `Company` profile
+ // on the specified date.
+ ProfileViews *AnalyticsDataPoint `json:"profileViews,omitempty"`
+
+ // SearchViews: Instances of users seeing the `Company` in Google
+ // Partners Search results
+ // on the specified date.
+ SearchViews *AnalyticsDataPoint `json:"searchViews,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Contacts") 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. "Contacts") 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 *Analytics) MarshalJSON() ([]byte, error) {
+ type noMethod Analytics
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AnalyticsDataPoint: Details of the analytics events for a `Company`
+// within a single day.
+type AnalyticsDataPoint struct {
+ // EventCount: Number of times the type of event occurred.
+ // Meaning depends on context (e.g. profile views, contacts, etc.).
+ EventCount int64 `json:"eventCount,omitempty"`
+
+ // EventLocations: Location information of where these events occurred.
+ EventLocations []*LatLng `json:"eventLocations,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "EventCount") 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. "EventCount") 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 *AnalyticsDataPoint) MarshalJSON() ([]byte, error) {
+ type noMethod AnalyticsDataPoint
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AnalyticsSummary: Analytics aggregated data for a `Company` for a
+// given date range.
+type AnalyticsSummary struct {
+ // ContactsCount: Aggregated number of times users contacted the
+ // `Company`
+ // for given date range.
+ ContactsCount int64 `json:"contactsCount,omitempty"`
+
+ // ProfileViewsCount: Aggregated number of profile views for the
+ // `Company` for given date range.
+ ProfileViewsCount int64 `json:"profileViewsCount,omitempty"`
+
+ // SearchViewsCount: Aggregated number of times users saw the
+ // `Company`
+ // in Google Partners Search results for given date range.
+ SearchViewsCount int64 `json:"searchViewsCount,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ContactsCount") 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. "ContactsCount") 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 *AnalyticsSummary) MarshalJSON() ([]byte, error) {
+ type noMethod AnalyticsSummary
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// AvailableOffer: Available Offers to be distributed.
+type AvailableOffer struct {
+ // Available: The number of codes for this offer that are available for
+ // distribution.
+ Available int64 `json:"available,omitempty"`
+
+ // CountryOfferInfos: Offer info by country.
+ CountryOfferInfos []*CountryOfferInfo `json:"countryOfferInfos,omitempty"`
+
+ // Description: Description of the offer.
+ Description string `json:"description,omitempty"`
+
+ // Id: ID of this offer.
+ Id int64 `json:"id,omitempty,string"`
+
+ // MaxAccountAge: The maximum age of an account [in days] to be
+ // eligible.
+ MaxAccountAge int64 `json:"maxAccountAge,omitempty"`
+
+ // Name: Name of the offer.
+ Name string `json:"name,omitempty"`
+
+ // OfferLevel: Level of this offer.
+ //
+ // Possible values:
+ // "OFFER_LEVEL_UNSPECIFIED" - Unset.
+ // "OFFER_LEVEL_DENY_PROBLEM" - Users/Agencies that have no offers
+ // because of a problem.
+ // "OFFER_LEVEL_DENY_CONTRACT" - Users/Agencies that have no offers
+ // due to contractural agreements.
+ // "OFFER_LEVEL_MANUAL" - Users/Agencies that have a
+ // manually-configured limit.
+ // "OFFER_LEVEL_LIMIT_0" - Some Agencies don't get any offers.
+ // "OFFER_LEVEL_LIMIT_5" - Basic level gets 5 per month.
+ // "OFFER_LEVEL_LIMIT_15" - Agencies with adequate AHI and spend get
+ // 15/month.
+ // "OFFER_LEVEL_LIMIT_50" - Badged partners (even in grace) get 50 per
+ // month.
+ OfferLevel string `json:"offerLevel,omitempty"`
+
+ // OfferType: Type of offer.
+ //
+ // Possible values:
+ // "OFFER_TYPE_UNSPECIFIED" - Unset.
+ // "OFFER_TYPE_SPEND_X_GET_Y" - AdWords spend X get Y.
+ // "OFFER_TYPE_VIDEO" - Youtube video.
+ // "OFFER_TYPE_SPEND_MATCH" - Spend Match up to Y.
+ OfferType string `json:"offerType,omitempty"`
+
+ // QualifiedCustomer: Customers who qualify for this offer.
+ QualifiedCustomer []*OfferCustomer `json:"qualifiedCustomer,omitempty"`
+
+ // QualifiedCustomersComplete: Whether or not the list of qualified
+ // customers is definitely complete.
+ QualifiedCustomersComplete bool `json:"qualifiedCustomersComplete,omitempty"`
+
+ // ShowSpecialOfferCopy: Should special text be shown on the offers
+ // page.
+ ShowSpecialOfferCopy bool `json:"showSpecialOfferCopy,omitempty"`
+
+ // Terms: Terms of the offer.
+ Terms string `json:"terms,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Available") 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. "Available") 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 *AvailableOffer) MarshalJSON() ([]byte, error) {
+ type noMethod AvailableOffer
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// Certification: A user's information on a specific certification.
+type Certification struct {
+ // Achieved: Whether this certification has been achieved.
+ Achieved bool `json:"achieved,omitempty"`
+
+ // CertificationType: The type of certification, the area of expertise.
+ //
+ // Possible values:
+ // "CERTIFICATION_TYPE_UNSPECIFIED" - Unchosen.
+ // "CT_ADWORDS" - AdWords certified.
+ // "CT_YOUTUBE" - YouTube certified.
+ // "CT_VIDEOADS" - VideoAds certified.
+ // "CT_ANALYTICS" - Analytics certified.
+ // "CT_DOUBLECLICK" - DoubleClick certified.
+ // "CT_SHOPPING" - Shopping certified.
+ // "CT_MOBILE" - Mobile certified.
+ // "CT_DIGITAL_SALES" - Digital sales certified.
+ // "CT_ADWORDS_SEARCH" - AdWords Search certified.
+ // "CT_ADWORDS_DISPLAY" - AdWords Display certified.
+ // "CT_MOBILE_SITES" - Mobile Sites certified.
+ CertificationType string `json:"certificationType,omitempty"`
+
+ // Expiration: Date this certification is due to expire.
+ Expiration string `json:"expiration,omitempty"`
+
+ // LastAchieved: The date the user last achieved certification.
+ LastAchieved string `json:"lastAchieved,omitempty"`
+
+ // Warning: Whether this certification is in the state of warning.
+ Warning bool `json:"warning,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Achieved") 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. "Achieved") 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 *Certification) MarshalJSON() ([]byte, error) {
+ type noMethod Certification
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CertificationExamStatus: Status for a Google Partners certification
// exam.
type CertificationExamStatus struct {
@@ -141,14 +512,17 @@
// Type: The type of certification exam.
//
// Possible values:
- // "CERTIFICATION_EXAM_TYPE_UNSPECIFIED"
- // "CET_ADWORDS_ADVANCED_SEARCH"
- // "CET_ADWORDS_ADVANCED_DISPLAY"
- // "CET_VIDEO_ADS"
- // "CET_ANALYTICS"
- // "CET_DOUBLECLICK"
- // "CET_SHOPPING"
- // "CET_MOBILE"
+ // "CERTIFICATION_EXAM_TYPE_UNSPECIFIED" - Unchosen.
+ // "CET_ADWORDS_FUNDAMENTALS" - Adwords Fundamentals exam.
+ // "CET_ADWORDS_ADVANCED_SEARCH" - AdWords advanced search exam.
+ // "CET_ADWORDS_ADVANCED_DISPLAY" - AdWords advanced display exam.
+ // "CET_VIDEO_ADS" - VideoAds exam.
+ // "CET_DOUBLECLICK" - DoubleClick exam.
+ // "CET_ANALYTICS" - Analytics exam.
+ // "CET_SHOPPING" - Shopping exam.
+ // "CET_MOBILE" - Mobile exam.
+ // "CET_DIGITAL_SALES" - Digital Sales exam.
+ // "CET_MOBILE_SITES" - Mobile Sites exam.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "NumberUsersPass") to
@@ -186,16 +560,23 @@
// Type: The type of the certification.
//
// Possible values:
- // "CERTIFICATION_TYPE_UNSPECIFIED"
- // "CT_ADWORDS"
- // "CT_YOUTUBE"
- // "CT_VIDEOADS"
- // "CT_ANALYTICS"
- // "CT_DOUBLECLICK"
- // "CT_SHOPPING"
- // "CT_MOBILE"
+ // "CERTIFICATION_TYPE_UNSPECIFIED" - Unchosen.
+ // "CT_ADWORDS" - AdWords certified.
+ // "CT_YOUTUBE" - YouTube certified.
+ // "CT_VIDEOADS" - VideoAds certified.
+ // "CT_ANALYTICS" - Analytics certified.
+ // "CT_DOUBLECLICK" - DoubleClick certified.
+ // "CT_SHOPPING" - Shopping certified.
+ // "CT_MOBILE" - Mobile certified.
+ // "CT_DIGITAL_SALES" - Digital sales certified.
+ // "CT_ADWORDS_SEARCH" - AdWords Search certified.
+ // "CT_ADWORDS_DISPLAY" - AdWords Display certified.
+ // "CT_MOBILE_SITES" - Mobile Sites certified.
Type string `json:"type,omitempty"`
+ // UserCount: Number of people who are certified,
+ UserCount int64 `json:"userCount,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "ExamStatuses") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -220,15 +601,61 @@
}
// Company: A company resource in the Google Partners API. Once
-// certified, it qualifies for being searched by advertisers.
+// certified, it qualifies
+// for being searched by advertisers.
type Company struct {
+ // AdditionalWebsites: URL of the company's additional websites used to
+ // verify the dynamic badges.
+ // These are stored as full URLs as entered by the user, but only the
+ // TLD will
+ // be used for the actual verification.
+ AdditionalWebsites []string `json:"additionalWebsites,omitempty"`
+
+ // AutoApprovalEmailDomains: Email domains that allow users with a
+ // matching email address to get
+ // auto-approved for associating with this company.
+ AutoApprovalEmailDomains []string `json:"autoApprovalEmailDomains,omitempty"`
+
+ // BadgeTier: Partner badge tier
+ //
+ // Possible values:
+ // "BADGE_TIER_NONE" - Tier badge is not set.
+ // "BADGE_TIER_REGULAR" - Agency has regular partner badge.
+ // "BADGE_TIER_PREMIER" - Agency has premier badge.
+ BadgeTier string `json:"badgeTier,omitempty"`
+
// CertificationStatuses: The list of Google Partners certification
// statuses for the company.
CertificationStatuses []*CertificationStatus `json:"certificationStatuses,omitempty"`
+ // CompanyTypes: Company type labels listed on the company's profile.
+ //
+ // Possible values:
+ // "COMPANY_TYPE_UNSPECIFIED" - Unchosen.
+ // "FULL_SERVICE_AGENCY" - Handles all aspects of the advertising
+ // process.
+ // "MEDIA_AGENCY" - Focuses solely on an advertiser's media placement.
+ // "CREATIVE_AGENCY" - Plans/executes advertising campaigns.
+ // "CDIGITAL_AGENCY" - Like a
+ // FULL_SERVICE_AGENCY,
+ // but specializing in digital.
+ // "SEM_SEO" - Increases visibility in search engine result pages.
+ // "PERFORMANCE_MARKETING" - Drives promotional efforts for immediate
+ // impact.
+ // "ADVERTISING_TOOL_DEVELOPMENT" - Focuses on bid management,
+ // conversion, reporting.
+ // "PR" - Establishes favorable relationship with public through
+ // low/no-cost
+ // communications.
+ // "SELF_MANAGED" - Does not manage other company's accounts, manages
+ // own marketing programs.
+ // "RESELLER" - Full-service AdWords account management for local
+ // businesses.
+ CompanyTypes []string `json:"companyTypes,omitempty"`
+
// ConvertedMinMonthlyBudget: The minimum monthly budget that the
- // company accepts for partner business, converted to the requested
- // currency code.
+ // company accepts for partner business,
+ // converted to the requested currency code.
ConvertedMinMonthlyBudget *Money `json:"convertedMinMonthlyBudget,omitempty"`
// Id: The ID of the company.
@@ -253,21 +680,53 @@
// LocalizedInfos: The list of localized info for the company.
LocalizedInfos []*LocalizedCompanyInfo `json:"localizedInfos,omitempty"`
- // Locations: The list of company locations.
+ // Locations: The list of all company locations.
+ // If set, must include the
+ // primary_location
+ // in the list.
Locations []*Location `json:"locations,omitempty"`
// Name: The name of the company.
Name string `json:"name,omitempty"`
// OriginalMinMonthlyBudget: The unconverted minimum monthly budget that
- // the company accepts for partner business.
+ // the company accepts for partner
+ // business.
OriginalMinMonthlyBudget *Money `json:"originalMinMonthlyBudget,omitempty"`
+ // PrimaryAdwordsManagerAccountId: The Primary AdWords Manager Account
+ // id.
+ PrimaryAdwordsManagerAccountId int64 `json:"primaryAdwordsManagerAccountId,omitempty,string"`
+
+ // PrimaryLanguageCode: The primary language code of the company, as
+ // defined by
+ // <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
+ // (IETF BCP 47, "Tags for Identifying Languages").
+ PrimaryLanguageCode string `json:"primaryLanguageCode,omitempty"`
+
+ // PrimaryLocation: The primary location of the company.
+ PrimaryLocation *Location `json:"primaryLocation,omitempty"`
+
+ // ProfileStatus: The public viewability status of the company's
+ // profile.
+ //
+ // Possible values:
+ // "COMPANY_PROFILE_STATUS_UNSPECIFIED" - Unchosen.
+ // "HIDDEN" - Company profile does not show up publicly.
+ // "PUBLISHED" - Company profile can only be viewed by the profile's
+ // URL
+ // and not by Google Partner Search.
+ // "SEARCHABLE" - Company profile can be viewed by the profile's
+ // URL
+ // and by Google Partner Search.
+ ProfileStatus string `json:"profileStatus,omitempty"`
+
// PublicProfile: Basic information from the company's public profile.
PublicProfile *PublicProfile `json:"publicProfile,omitempty"`
// Ranks: Information related to the ranking of the company within the
- // list of companies.
+ // list of
+ // companies.
Ranks []*Rank `json:"ranks,omitempty"`
// Services: Services the company can help with.
@@ -279,21 +738,29 @@
// "S_AN_ENHANCED_WEBSITE" - Help with an enhanced website.
// "S_AN_ONLINE_MARKETING_PLAN" - Help with an online marketing plan.
// "S_MOBILE_AND_VIDEO_ADS" - Help with mobile and video ads.
+ // "S_MOBILE_WEBSITE_SERVICES" - Help with mobile websites.
Services []string `json:"services,omitempty"`
+ // SpecializationStatus: The list of Google Partners specialization
+ // statuses for the company.
+ SpecializationStatus []*SpecializationStatus `json:"specializationStatus,omitempty"`
+
// WebsiteUrl: URL of the company's website.
WebsiteUrl string `json:"websiteUrl,omitempty"`
- // ForceSendFields is a list of field names (e.g.
- // "CertificationStatuses") 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.
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AdditionalWebsites")
+ // 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. "CertificationStatuses") to
+ // NullFields is a list of field names (e.g. "AdditionalWebsites") 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
@@ -309,14 +776,170 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// CompanyRelation: A CompanyRelation resource representing information
+// about a user's
+// affiliation and standing with a company in Partners.
+type CompanyRelation struct {
+ // Address: The primary address for this company.
+ Address string `json:"address,omitempty"`
+
+ // BadgeTier: Whether the company is a Partner.
+ //
+ // Possible values:
+ // "BADGE_TIER_NONE" - Tier badge is not set.
+ // "BADGE_TIER_REGULAR" - Agency has regular partner badge.
+ // "BADGE_TIER_PREMIER" - Agency has premier badge.
+ BadgeTier string `json:"badgeTier,omitempty"`
+
+ // CompanyAdmin: Indicates if the user is an admin for this company.
+ CompanyAdmin bool `json:"companyAdmin,omitempty"`
+
+ // CompanyId: The ID of the company. There may be no id if this is
+ // a
+ // pending company.5
+ CompanyId string `json:"companyId,omitempty"`
+
+ // CreationTime: The timestamp of when affiliation was
+ // requested.
+ // @OutputOnly
+ CreationTime string `json:"creationTime,omitempty"`
+
+ // IsPending: The flag that indicates if the company is pending
+ // verification.
+ IsPending bool `json:"isPending,omitempty"`
+
+ // LogoUrl: A URL to a profile photo, e.g. a G+ profile photo.
+ LogoUrl string `json:"logoUrl,omitempty"`
+
+ // ManagerAccount: The AdWords manager account # associated this
+ // company.
+ ManagerAccount int64 `json:"managerAccount,omitempty,string"`
+
+ // Name: The name (in the company's primary language) for the company.
+ Name string `json:"name,omitempty"`
+
+ // PhoneNumber: The phone number for the company's primary address.
+ PhoneNumber string `json:"phoneNumber,omitempty"`
+
+ // ResolvedTimestamp: The timestamp when the user was
+ // approved.
+ // @OutputOnly
+ ResolvedTimestamp string `json:"resolvedTimestamp,omitempty"`
+
+ // Segment: The segment the company is classified as.
+ //
+ // Possible values:
+ // "COMPANY_SEGMENT_UNKNOWN" - Default segment indicates an unknown.
+ // "COMPANY_SEGMENT_NAL" - Segment representing a selected group of
+ // Partners
+ // "COMPANY_SEGMENT_PSP" - Segment representing Premier SMB Partners,
+ // an AdWords partnership program.
+ // "COMPANY_SEGMENT_PPSP" - A segment of Premier SMB Partners that
+ // have relationship with Google.
+ Segment []string `json:"segment,omitempty"`
+
+ // SpecializationStatus: The list of Google Partners specialization
+ // statuses for the company.
+ SpecializationStatus []*SpecializationStatus `json:"specializationStatus,omitempty"`
+
+ // State: The state of relationship, in terms of approvals.
+ //
+ // Possible values:
+ // "USER_COMPANY_REATION_STATE_NONE_SPECIFIED" - Default unspecified
+ // value.
+ // "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL" - User has filled in a
+ // request to be associated with an company.
+ // Now waiting email confirmation.
+ // "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN" - Pending approval from
+ // company.
+ // Email confirmation will not approve this one.
+ // "USER_COMPANY_RELATION_STATE_APPROVED" - Approved by company.
+ State string `json:"state,omitempty"`
+
+ // Website: The website URL for this company.
+ Website string `json:"website,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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 *CompanyRelation) MarshalJSON() ([]byte, error) {
+ type noMethod CompanyRelation
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// CountryOfferInfo: Offer info by country.
+type CountryOfferInfo struct {
+ // GetYAmount: (localized) Get Y amount for that country's offer.
+ GetYAmount string `json:"getYAmount,omitempty"`
+
+ // OfferCountryCode: Country code for which offer codes may be
+ // requested.
+ OfferCountryCode string `json:"offerCountryCode,omitempty"`
+
+ // OfferType: Type of offer country is eligible for.
+ //
+ // Possible values:
+ // "OFFER_TYPE_UNSPECIFIED" - Unset.
+ // "OFFER_TYPE_SPEND_X_GET_Y" - AdWords spend X get Y.
+ // "OFFER_TYPE_VIDEO" - Youtube video.
+ // "OFFER_TYPE_SPEND_MATCH" - Spend Match up to Y.
+ OfferType string `json:"offerType,omitempty"`
+
+ // SpendXAmount: (localized) Spend X amount for that country's offer.
+ SpendXAmount string `json:"spendXAmount,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "GetYAmount") 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. "GetYAmount") 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 *CountryOfferInfo) MarshalJSON() ([]byte, error) {
+ type noMethod CountryOfferInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// CreateLeadRequest: Request message for CreateLead.
type CreateLeadRequest struct {
// Lead: The lead resource. The `LeadType` must not be
- // `LEAD_TYPE_UNSPECIFIED` and either `email` or `phone_number` must be
- // provided.
+ // `LEAD_TYPE_UNSPECIFIED`
+ // and either `email` or `phone_number` must be provided.
Lead *Lead `json:"lead,omitempty"`
- // RecaptchaChallenge: reCaptcha challenge info.
+ // RecaptchaChallenge: <a
+ // href="https://www.google.com/recaptcha/">reCaptcha</a> challenge
+ // info.
RecaptchaChallenge *RecaptchaChallenge `json:"recaptchaChallenge,omitempty"`
// RequestMetadata: Current request metadata.
@@ -345,20 +968,21 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// CreateLeadResponse: Response message for CreateLead. Debug
-// information about this request.
+// CreateLeadResponse: Response message for CreateLead.
type CreateLeadResponse struct {
- // Lead: Lead that was created depending on the outcome of reCaptcha
- // validation.
+ // Lead: Lead that was created depending on the outcome of
+ // <a href="https://www.google.com/recaptcha/">reCaptcha</a> validation.
Lead *Lead `json:"lead,omitempty"`
- // RecaptchaStatus: The outcome of reCaptcha validation.
+ // RecaptchaStatus: The outcome of <a
+ // href="https://www.google.com/recaptcha/">reCaptcha</a>
+ // validation.
//
// Possible values:
- // "RECAPTCHA_STATUS_UNSPECIFIED"
- // "RS_NOT_NEEDED"
- // "RS_PASSED"
- // "RS_FAILED"
+ // "RECAPTCHA_STATUS_UNSPECIFIED" - Unchosen.
+ // "RS_NOT_NEEDED" - No reCaptcha validation needed.
+ // "RS_PASSED" - reCaptcha challenge passed.
+ // "RS_FAILED" - reCaptcha challenge failed.
RecaptchaStatus string `json:"recaptchaStatus,omitempty"`
// ResponseMetadata: Current response metadata.
@@ -391,6 +1015,56 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Date: Represents a whole calendar date, e.g. date of birth. The time
+// of day and
+// time zone are either specified elsewhere or are not significant. The
+// date
+// is relative to the Proleptic Gregorian Calendar. The day may be 0
+// to
+// represent a year and month where the day is not significant, e.g.
+// credit card
+// expiration date. The year may be 0 to represent a month and day
+// independent
+// of year, e.g. anniversary date. Related types are
+// google.type.TimeOfDay
+// and `google.protobuf.Timestamp`.
+type Date struct {
+ // Day: Day of month. Must be from 1 to 31 and valid for the year and
+ // month, or 0
+ // if specifying a year/month where the day is not significant.
+ Day int64 `json:"day,omitempty"`
+
+ // Month: Month of year. Must be from 1 to 12.
+ Month int64 `json:"month,omitempty"`
+
+ // Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
+ // without
+ // a year.
+ Year int64 `json:"year,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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 *Date) MarshalJSON() ([]byte, error) {
+ type noMethod Date
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// DebugInfo: Debug information about this request.
type DebugInfo struct {
// ServerInfo: Info about the server that serviced this request.
@@ -425,49 +1099,67 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Empty: 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:
+//
+// service Foo {
+// rpc Bar(google.protobuf.Empty) returns
+// (google.protobuf.Empty);
+// }
+//
+// The JSON representation for `Empty` is empty JSON object `{}`.
+type Empty struct {
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+}
+
// EventData: Key value data pair for an event.
type EventData struct {
// Key: Data type.
//
// Possible values:
- // "EVENT_DATA_TYPE_UNSPECIFIED"
- // "ACTION"
- // "AGENCY_ID"
- // "AGENCY_NAME"
- // "AGENCY_PHONE_NUMBER"
- // "AGENCY_WEBSITE"
- // "BUDGET"
- // "CENTER_POINT"
- // "CERTIFICATION"
- // "COMMENT"
- // "COUNTRY"
- // "CURRENCY"
- // "CURRENTLY_VIEWED_AGENCY_ID"
- // "DISTANCE"
- // "DISTANCE_TYPE"
- // "EXAM"
- // "HISTORY_TOKEN"
- // "IDENTIFIER"
- // "INDUSTRY"
- // "INSIGHT_TAG"
- // "LANGUAGE"
- // "LOCATION"
- // "MARKETING_OPT_IN"
- // "QUERY"
- // "SEARCH_START_INDEX"
- // "SERVICE"
- // "SHOW_VOW"
- // "SOLUTION"
- // "TRAFFIC_SOURCE_ID"
- // "TRAFFIC_SUB_ID"
- // "VIEW_PORT"
- // "WEBSITE"
- // "DETAILS"
- // "EXPERIMENT_ID"
- // "GPS_MOTIVATION"
- // "URL"
- // "ELEMENT_FOCUS"
- // "PROGRESS"
+ // "EVENT_DATA_TYPE_UNSPECIFIED" - Unchosen.
+ // "ACTION" - Action data.
+ // "AGENCY_ID" - Agency ID data.
+ // "AGENCY_NAME" - Agency name data.
+ // "AGENCY_PHONE_NUMBER" - Agency phone number data.
+ // "AGENCY_WEBSITE" - Agency website data.
+ // "BUDGET" - Budget data.
+ // "CENTER_POINT" - Center-point data.
+ // "CERTIFICATION" - Certification data.
+ // "COMMENT" - Comment data.
+ // "COUNTRY" - Country data.
+ // "CURRENCY" - Currency data.
+ // "CURRENTLY_VIEWED_AGENCY_ID" - Currently viewed agency ID data.
+ // "DISTANCE" - Distance data.
+ // "DISTANCE_TYPE" - Distance type data.
+ // "EXAM" - Exam data.
+ // "HISTORY_TOKEN" - History token data.
+ // "ID" - Identifier data.
+ // "INDUSTRY" - Industry data.
+ // "INSIGHT_TAG" - Insight tag data.
+ // "LANGUAGE" - Language data.
+ // "LOCATION" - Location data.
+ // "MARKETING_OPT_IN" - Marketing opt-in data.
+ // "QUERY" - Query data.
+ // "SEARCH_START_INDEX" - Search start index data.
+ // "SERVICE" - Service data.
+ // "SHOW_VOW" - Show vow data.
+ // "SOLUTION" - Solution data.
+ // "TRAFFIC_SOURCE_ID" - Traffic source ID data.
+ // "TRAFFIC_SUB_ID" - Traffic sub ID data.
+ // "VIEW_PORT" - Viewport data.
+ // "WEBSITE" - Website data.
+ // "DETAILS" - Details data.
+ // "EXPERIMENT_ID" - Experiment ID data.
+ // "GPS_MOTIVATION" - Google Partner Search motivation data.
+ // "URL" - URL data.
+ // "ELEMENT_FOCUS" - Element we wanted user to focus on.
+ // "PROGRESS" - Progress when viewing an item \[0-100\].
Key string `json:"key,omitempty"`
// Values: Data values.
@@ -496,6 +1188,113 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ExamStatus: A user's information on a specific exam.
+type ExamStatus struct {
+ // ExamType: The type of the exam.
+ //
+ // Possible values:
+ // "CERTIFICATION_EXAM_TYPE_UNSPECIFIED" - Unchosen.
+ // "CET_ADWORDS_FUNDAMENTALS" - Adwords Fundamentals exam.
+ // "CET_ADWORDS_ADVANCED_SEARCH" - AdWords advanced search exam.
+ // "CET_ADWORDS_ADVANCED_DISPLAY" - AdWords advanced display exam.
+ // "CET_VIDEO_ADS" - VideoAds exam.
+ // "CET_DOUBLECLICK" - DoubleClick exam.
+ // "CET_ANALYTICS" - Analytics exam.
+ // "CET_SHOPPING" - Shopping exam.
+ // "CET_MOBILE" - Mobile exam.
+ // "CET_DIGITAL_SALES" - Digital Sales exam.
+ // "CET_MOBILE_SITES" - Mobile Sites exam.
+ ExamType string `json:"examType,omitempty"`
+
+ // Expiration: Date this exam is due to expire.
+ Expiration string `json:"expiration,omitempty"`
+
+ // LastPassed: The date the user last passed this exam.
+ LastPassed string `json:"lastPassed,omitempty"`
+
+ // Passed: Whether this exam has been passed and not expired.
+ Passed bool `json:"passed,omitempty"`
+
+ // Taken: The date the user last taken this exam.
+ Taken string `json:"taken,omitempty"`
+
+ // Warning: Whether this exam is in the state of warning.
+ Warning bool `json:"warning,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ExamType") 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. "ExamType") 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 *ExamStatus) MarshalJSON() ([]byte, error) {
+ type noMethod ExamStatus
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ExamToken: A token that allows a user to take an exam.
+type ExamToken struct {
+ // ExamId: The id of the exam the token is for.
+ ExamId int64 `json:"examId,omitempty,string"`
+
+ // ExamType: The type of the exam the token belongs to.
+ //
+ // Possible values:
+ // "CERTIFICATION_EXAM_TYPE_UNSPECIFIED" - Unchosen.
+ // "CET_ADWORDS_FUNDAMENTALS" - Adwords Fundamentals exam.
+ // "CET_ADWORDS_ADVANCED_SEARCH" - AdWords advanced search exam.
+ // "CET_ADWORDS_ADVANCED_DISPLAY" - AdWords advanced display exam.
+ // "CET_VIDEO_ADS" - VideoAds exam.
+ // "CET_DOUBLECLICK" - DoubleClick exam.
+ // "CET_ANALYTICS" - Analytics exam.
+ // "CET_SHOPPING" - Shopping exam.
+ // "CET_MOBILE" - Mobile exam.
+ // "CET_DIGITAL_SALES" - Digital Sales exam.
+ // "CET_MOBILE_SITES" - Mobile Sites exam.
+ ExamType string `json:"examType,omitempty"`
+
+ // Token: The token, only present if the user has access to the exam.
+ Token string `json:"token,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ExamId") 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. "ExamId") 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 *ExamToken) MarshalJSON() ([]byte, error) {
+ type noMethod ExamToken
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// GetCompanyResponse: Response message for GetCompany.
type GetCompanyResponse struct {
// Company: The company.
@@ -531,30 +1330,163 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// GetPartnersStatusResponse: Response message for
+// GetPartnersStatus.
+type GetPartnersStatusResponse struct {
+ // ResponseMetadata: Current response metadata.
+ ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "ResponseMetadata") 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. "ResponseMetadata") 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 *GetPartnersStatusResponse) MarshalJSON() ([]byte, error) {
+ type noMethod GetPartnersStatusResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// HistoricalOffer: Historical information about a Google Partners
+// Offer.
+type HistoricalOffer struct {
+ // AdwordsUrl: Client's AdWords page URL.
+ AdwordsUrl string `json:"adwordsUrl,omitempty"`
+
+ // ClientEmail: Email address for client.
+ ClientEmail string `json:"clientEmail,omitempty"`
+
+ // ClientId: ID of client.
+ ClientId int64 `json:"clientId,omitempty,string"`
+
+ // ClientName: Name of the client.
+ ClientName string `json:"clientName,omitempty"`
+
+ // CreationTime: Time offer was first created.
+ CreationTime string `json:"creationTime,omitempty"`
+
+ // ExpirationTime: Time this offer expires.
+ ExpirationTime string `json:"expirationTime,omitempty"`
+
+ // LastModifiedTime: Time last action was taken.
+ LastModifiedTime string `json:"lastModifiedTime,omitempty"`
+
+ // OfferCode: Offer code.
+ OfferCode string `json:"offerCode,omitempty"`
+
+ // OfferCountryCode: Country Code for the offer country.
+ OfferCountryCode string `json:"offerCountryCode,omitempty"`
+
+ // OfferType: Type of offer.
+ //
+ // Possible values:
+ // "OFFER_TYPE_UNSPECIFIED" - Unset.
+ // "OFFER_TYPE_SPEND_X_GET_Y" - AdWords spend X get Y.
+ // "OFFER_TYPE_VIDEO" - Youtube video.
+ // "OFFER_TYPE_SPEND_MATCH" - Spend Match up to Y.
+ OfferType string `json:"offerType,omitempty"`
+
+ // SenderName: Name (First + Last) of the partners user to whom the
+ // incentive is allocated.
+ SenderName string `json:"senderName,omitempty"`
+
+ // Status: Status of the offer.
+ //
+ // Possible values:
+ // "OFFER_STATUS_UNSPECIFIED" - Unset.
+ // "OFFER_STATUS_DISTRIBUTED" - Offer distributed.
+ // "OFFER_STATUS_REDEEMED" - Offer redeemed.
+ // "OFFER_STATUS_AWARDED" - Offer awarded.
+ // "OFFER_STATUS_EXPIRED" - Offer expired.
+ Status string `json:"status,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AdwordsUrl") 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. "AdwordsUrl") 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 *HistoricalOffer) MarshalJSON() ([]byte, error) {
+ type noMethod HistoricalOffer
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// LatLng: An object representing a latitude/longitude pair. This is
-// expressed as a pair of doubles representing degrees latitude and
-// degrees longitude. Unless specified otherwise, this must conform to
-// the WGS84 standard. Values must be within normalized ranges. Example
-// of normalization code in Python: def NormalizeLongitude(longitude):
-// """Wrapsdecimal degrees longitude to [-180.0, 180.0].""" q, r =
-// divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0):
-// return r - 360.0 return r def NormalizeLatLng(latitude, longitude):
-// """Wraps decimal degrees latitude and longitude to [-180.0, 180.0]
-// and [-90.0, 90.0], respectively.""" r = latitude % 360.0 if r =
-// 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180
-// - r, NormalizeLongitude(longitude + 180.0) assert 180.0 ==
-// NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0)
-// assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) ==
-// NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) ==
-// NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) ==
-// NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) ==
-// NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) ==
-// NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) ==
-// NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) ==
-// NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
-// NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) ==
-// NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) ==
-// NormalizeLatLng(-270.0, 10.0)
+// expressed as a pair
+// of doubles representing degrees latitude and degrees longitude.
+// Unless
+// specified otherwise, this must conform to the
+// <a
+// href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+// st
+// andard</a>. Values must be within normalized ranges.
+//
+// Example of normalization code in Python:
+//
+// def NormalizeLongitude(longitude):
+// """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+// q, r = divmod(longitude, 360.0)
+// if r > 180.0 or (r == 180.0 and q <= -1.0):
+// return r - 360.0
+// return r
+//
+// def NormalizeLatLng(latitude, longitude):
+// """Wraps decimal degrees latitude and longitude to
+// [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+// r = latitude % 360.0
+// if r <= 90.0:
+// return r, NormalizeLongitude(longitude)
+// elif r >= 270.0:
+// return r - 360, NormalizeLongitude(longitude)
+// else:
+// return 180 - r, NormalizeLongitude(longitude + 180.0)
+//
+// assert 180.0 == NormalizeLongitude(180.0)
+// assert -180.0 == NormalizeLongitude(-180.0)
+// assert -179.0 == NormalizeLongitude(181.0)
+// assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+// assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+// assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+// assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+// assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+// assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+// assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+// assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+// assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+// assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+//
+// The code in logs/storage/validator/logs_validator_traits.cc treats
+// this type
+// as if it were annotated as ST_LOCATION.
type LatLng struct {
// Latitude: The latitude in degrees. It must be in the range [-90.0,
// +90.0].
@@ -604,12 +1536,19 @@
}
// Lead: A lead resource that represents an advertiser contact for a
-// `Company`. These are usually generated via Google Partner Search (the
-// advertiser portal).
+// `Company`. These
+// are usually generated via Google Partner Search (the advertiser
+// portal).
type Lead struct {
+ // AdwordsCustomerId: The AdWords Customer ID of the lead.
+ AdwordsCustomerId int64 `json:"adwordsCustomerId,omitempty,string"`
+
// Comments: Comments lead source gave.
Comments string `json:"comments,omitempty"`
+ // CreateTime: Timestamp of when this lead was created.
+ CreateTime string `json:"createTime,omitempty"`
+
// Email: Email address of lead source.
Email string `json:"email,omitempty"`
@@ -634,6 +1573,16 @@
// Id: ID of the lead.
Id string `json:"id,omitempty"`
+ // LanguageCode: Language code of the lead's language preference, as
+ // defined by
+ // <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
+ // (IETF BCP 47, "Tags for Identifying Languages").
+ LanguageCode string `json:"languageCode,omitempty"`
+
+ // MarketingOptIn: Whether or not the lead signed up for marketing
+ // emails
+ MarketingOptIn bool `json:"marketingOptIn,omitempty"`
+
// MinMonthlyBudget: The minimum monthly budget lead source is willing
// to spend.
MinMonthlyBudget *Money `json:"minMonthlyBudget,omitempty"`
@@ -641,30 +1590,45 @@
// PhoneNumber: Phone number of lead source.
PhoneNumber string `json:"phoneNumber,omitempty"`
+ // State: The lead's state in relation to the company.
+ //
+ // Possible values:
+ // "LEAD_STATE_UNSPECIFIED" - Unchosen.
+ // "LEAD" - Lead not yet contacted.
+ // "CONTACTED" - Lead has been contacted.
+ // "CLIENT" - Lead has become a client.
+ // "OTHER" - Lead in a state not covered by other options.
+ State string `json:"state,omitempty"`
+
// Type: Type of lead.
//
// Possible values:
- // "LEAD_TYPE_UNSPECIFIED"
- // "LT_GPS"
+ // "LEAD_TYPE_UNSPECIFIED" - Unchosen.
+ // "LT_GPS" - Google Partner Search.
Type string `json:"type,omitempty"`
// WebsiteUrl: Website URL of lead source.
WebsiteUrl string `json:"websiteUrl,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Comments") to
- // unconditionally include in API requests. By default, fields with
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AdwordsCustomerId")
+ // 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. "Comments") 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. "AdwordsCustomerId") 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:"-"`
}
@@ -674,15 +1638,69 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ListCompaniesResponse: Response message for ListCompanies.
+// ListAnalyticsResponse: Response message for
+// ListAnalytics.
+type ListAnalyticsResponse struct {
+ // Analytics: The list of analytics.
+ // Sorted in ascending order of
+ // Analytics.event_date.
+ Analytics []*Analytics `json:"analytics,omitempty"`
+
+ // AnalyticsSummary: Aggregated information across the
+ // response's
+ // analytics.
+ AnalyticsSummary *AnalyticsSummary `json:"analyticsSummary,omitempty"`
+
+ // NextPageToken: A token to retrieve next page of results.
+ // Pass this value in the `ListAnalyticsRequest.page_token` field in
+ // the
+ // subsequent call to
+ // ListAnalytics to retrieve the
+ // next page of results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ResponseMetadata: Current response metadata.
+ ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Analytics") 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. "Analytics") 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 *ListAnalyticsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListAnalyticsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListCompaniesResponse: Response message for
+// ListCompanies.
type ListCompaniesResponse struct {
// Companies: The list of companies.
Companies []*Company `json:"companies,omitempty"`
- // NextPageToken: A token to retrieve next page of results. Pass this
- // value in the `ListCompaniesRequest.page_token` field in the
- // subsequent call to ListCompanies to retrieve the next page of
- // results.
+ // NextPageToken: A token to retrieve next page of results.
+ // Pass this value in the `ListCompaniesRequest.page_token` field in
+ // the
+ // subsequent call to
+ // ListCompanies to retrieve the
+ // next page of results.
NextPageToken string `json:"nextPageToken,omitempty"`
// ResponseMetadata: Current response metadata.
@@ -715,7 +1733,151 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// ListUserStatesResponse: Response message for ListUserStates.
+// ListLeadsResponse: Response message for ListLeads.
+type ListLeadsResponse struct {
+ // Leads: The list of leads.
+ Leads []*Lead `json:"leads,omitempty"`
+
+ // NextPageToken: A token to retrieve next page of results.
+ // Pass this value in the `ListLeadsRequest.page_token` field in
+ // the
+ // subsequent call to
+ // ListLeads to retrieve the
+ // next page of results.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // ResponseMetadata: Current response metadata.
+ ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
+
+ // TotalSize: The total count of leads for the given company.
+ TotalSize int64 `json:"totalSize,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Leads") 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. "Leads") 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 *ListLeadsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListLeadsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListOffersHistoryResponse: Response for ListOfferHistory.
+type ListOffersHistoryResponse struct {
+ // CanShowEntireCompany: True if the user has the option to show entire
+ // company history.
+ CanShowEntireCompany bool `json:"canShowEntireCompany,omitempty"`
+
+ // NextPageToken: Supply this token in a ListOffersHistoryRequest to
+ // retrieve the next page.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Offers: Historical offers meeting request.
+ Offers []*HistoricalOffer `json:"offers,omitempty"`
+
+ // ResponseMetadata: Current response metadata.
+ ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
+
+ // ShowingEntireCompany: True if this response is showing entire company
+ // history.
+ ShowingEntireCompany bool `json:"showingEntireCompany,omitempty"`
+
+ // TotalResults: Number of results across all pages.
+ TotalResults int64 `json:"totalResults,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "CanShowEntireCompany") 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. "CanShowEntireCompany") 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 *ListOffersHistoryResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListOffersHistoryResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListOffersResponse: Response for ListOffer.
+type ListOffersResponse struct {
+ // AvailableOffers: Available Offers to be distributed.
+ AvailableOffers []*AvailableOffer `json:"availableOffers,omitempty"`
+
+ // NoOfferReason: Reason why no Offers are available.
+ //
+ // Possible values:
+ // "NO_OFFER_REASON_UNSPECIFIED" - Unset.
+ // "NO_OFFER_REASON_NO_MCC" - Not an MCC.
+ // "NO_OFFER_REASON_LIMIT_REACHED" - Offer limit has been reached.
+ // "NO_OFFER_REASON_INELIGIBLE" - Ineligible for offers.
+ NoOfferReason string `json:"noOfferReason,omitempty"`
+
+ // ResponseMetadata: Current response metadata.
+ ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "AvailableOffers") 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. "AvailableOffers") 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 *ListOffersResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListOffersResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// ListUserStatesResponse: Response message for
+// ListUserStates.
type ListUserStatesResponse struct {
// ResponseMetadata: Current response metadata.
ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
@@ -724,8 +1886,9 @@
//
// Possible values:
// "USER_STATE_UNSPECIFIED" - Unchosen.
- // "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT" - User must pass reCaptcha
- // to contact a Partner via Google Partner Search.
+ // "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT" - User must pass <a
+ // href="https://www.google.com/recaptcha/">reCaptcha</a> to
+ // contact a Partner via Google Partner Search.
UserStates []string `json:"userStates,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -765,7 +1928,9 @@
DisplayName string `json:"displayName,omitempty"`
// LanguageCode: Language code of the localized company info, as defined
- // by BCP 47 (IETF BCP 47, "Tags for Identifying Languages").
+ // by
+ // <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
+ // (IETF BCP 47, "Tags for Identifying Languages").
LanguageCode string `json:"languageCode,omitempty"`
// Overview: Localized brief description that the company uses to
@@ -795,14 +1960,48 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// Location: A location with address and geographic coordinates.
+// Location: A location with address and geographic coordinates. May
+// optionally contain a
+// detailed (multi-field) version of the address.
type Location struct {
- // Address: The complete address of the location.
+ // Address: The single string version of the address.
Address string `json:"address,omitempty"`
+ // AddressLine: The following address lines represent the most specific
+ // part of any
+ // address.
+ AddressLine []string `json:"addressLine,omitempty"`
+
+ // AdministrativeArea: Top-level administrative subdivision of this
+ // country.
+ AdministrativeArea string `json:"administrativeArea,omitempty"`
+
+ // DependentLocality: Dependent locality or sublocality. Used for UK
+ // dependent localities, or
+ // neighborhoods or boroughs in other locations.
+ DependentLocality string `json:"dependentLocality,omitempty"`
+
+ // LanguageCode: Language code of the address. Should be in BCP 47
+ // format.
+ LanguageCode string `json:"languageCode,omitempty"`
+
// LatLng: The latitude and longitude of the location, in degrees.
LatLng *LatLng `json:"latLng,omitempty"`
+ // Locality: Generally refers to the city/town portion of an address.
+ Locality string `json:"locality,omitempty"`
+
+ // PostalCode: Values are frequently alphanumeric.
+ PostalCode string `json:"postalCode,omitempty"`
+
+ // RegionCode: CLDR (Common Locale Data Repository) region code .
+ RegionCode string `json:"regionCode,omitempty"`
+
+ // SortingCode: Use of this code is very country-specific, but will
+ // refer to a secondary
+ // classification code for sorting mail.
+ SortingCode string `json:"sortingCode,omitempty"`
+
// ForceSendFields is a list of field names (e.g. "Address") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
@@ -826,7 +2025,8 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// LogMessageRequest: Request message for LogClientMessage.
+// LogMessageRequest: Request message for
+// LogClientMessage.
type LogMessageRequest struct {
// ClientInfo: Map of client info, such as URL, browser navigator,
// browser platform, etc.
@@ -838,11 +2038,11 @@
// Level: Message level of client message.
//
// Possible values:
- // "MESSAGE_LEVEL_UNSPECIFIED"
- // "ML_FINE"
- // "ML_INFO"
- // "ML_WARNING"
- // "ML_SEVERE"
+ // "MESSAGE_LEVEL_UNSPECIFIED" - Unchosen.
+ // "ML_FINE" - Message level for tracing information.
+ // "ML_INFO" - Message level for informational messages.
+ // "ML_WARNING" - Message level for potential problems.
+ // "ML_SEVERE" - Message level for serious failures.
Level string `json:"level,omitempty"`
// RequestMetadata: Current request metadata.
@@ -871,7 +2071,8 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// LogMessageResponse: Response message for LogClientMessage.
+// LogMessageResponse: Response message for
+// LogClientMessage.
type LogMessageResponse struct {
// ResponseMetadata: Current response metadata.
ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
@@ -904,186 +2105,342 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// LogUserEventRequest: Request message for LogUserEvent.
+// LogUserEventRequest: Request message for
+// LogUserEvent.
type LogUserEventRequest struct {
// EventAction: The action that occurred.
//
// Possible values:
- // "EVENT_ACTION_UNSPECIFIED"
- // "SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM"
- // "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP"
- // "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM"
- // "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP"
- // "SMB_CANCELED_PARTNER_CONTACT_FORM"
- // "SMB_CLICKED_CONTACT_A_PARTNER"
- // "SMB_COMPLETED_PARTNER_CONTACT_FORM"
- // "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM"
- // "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM"
- // "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM"
- // "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM"
- // "PARTNER_VIEWED_BY_SMB"
- // "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS"
- // "SMB_CHANGED_A_SEARCH_PARAMETER_TOP"
- // "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS"
- // "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM"
- // "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS"
- // "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA"
- // "SMB_PERFORMED_SEARCH_ON_GPS"
- // "SMB_VIEWED_A_PARTNER_ON_GPS"
- // "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE"
- // "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE"
- // "SMB_CLICKED_PARTNER_WEBSITE"
- // "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE"
- // "SMB_VIEWED_A_PARTNER_PROFILE"
- // "AGENCY_CLICKED_ACCEPT_TOS_BUTTON"
- // "AGENCY_CHANGED_TOS_COUNTRY"
- // "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION"
- // "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION"
- // "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL"
- // "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE"
- // "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL"
- // "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL"
- // "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE"
- // "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL"
- // "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE"
- // "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE"
- // "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL"
- // "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN"
- // "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION"
- // "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION"
- // "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN"
- // "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL"
- // "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL"
- // "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN"
- // "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN"
- // "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE"
- // "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP"
- // "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH"
- // "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS"
- // "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL"
- // "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS"
- // "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS"
- // "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL"
- // "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY"
- // "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY"
- // "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND"
- // "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND"
- // "AGECNY_CLICKED_LOG_OUT_CONNECT_WITH_COMPANY_NOT_FOUND"
- // "AGENCY_CLICKED_SKIP_FOR_NOW_ON_CONNECT_WITH_COMPANY_PAGE"
- // "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY"
- // "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY"
- // "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH"
- // "AGENCY_SUCCESSFULLY_CREATED_COMPANY"
- // "AGENCY_ADDED_NEW_COMPANY_LOCATION"
- // "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS"
- // "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS"
- // "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS"
+ // "EVENT_ACTION_UNSPECIFIED" - Unchosen.
+ // "SMB_CLICKED_FIND_A_PARTNER_BUTTON_BOTTOM" - Advertiser clicked
+ // `Find a partner` bottom button.
+ // "SMB_CLICKED_FIND_A_PARTNER_BUTTON_TOP" - Advertiser clicked `Find
+ // a partner` top button.
+ // "AGENCY_CLICKED_JOIN_NOW_BUTTON_BOTTOM" - Agency clicked `Join now`
+ // bottom button.
+ // "AGENCY_CLICKED_JOIN_NOW_BUTTON_TOP" - Agency clicked `Join now`
+ // top button.
+ // "SMB_CANCELED_PARTNER_CONTACT_FORM" - Advertiser canceled partner
+ // contact form.
+ // "SMB_CLICKED_CONTACT_A_PARTNER" - Advertiser started partner
+ // contact form.
+ // "SMB_COMPLETED_PARTNER_CONTACT_FORM" - Advertiser completed partner
+ // contact form.
+ // "SMB_ENTERED_EMAIL_IN_CONTACT_PARTNER_FORM" - Advertiser entered
+ // email in contact form.
+ // "SMB_ENTERED_NAME_IN_CONTACT_PARTNER_FORM" - Advertiser entered
+ // name in contact form.
+ // "SMB_ENTERED_PHONE_IN_CONTACT_PARTNER_FORM" - Advertiser entered
+ // phone in contact form.
+ // "SMB_FAILED_RECAPTCHA_IN_CONTACT_PARTNER_FORM" - Advertiser failed
+ // <a href="https://www.google.com/recaptcha/">reCaptcha</a>
+ // in contact form.
+ // "PARTNER_VIEWED_BY_SMB" - Company viewed by advertiser.
+ // "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_GPS" - Advertiser canceled
+ // partner contact form on Google Partner Search.
+ // "SMB_CHANGED_A_SEARCH_PARAMETER_TOP" - Advertiser changed a top
+ // search parameter.
+ // "SMB_CLICKED_CONTACT_A_PARTNER_ON_GPS" - Advertiser started partner
+ // contact form on Google Partner Search.
+ // "SMB_CLICKED_SHOW_MORE_PARTNERS_BUTTON_BOTTOM" - Advertiser clicked
+ // `Show more partners` bottom button.
+ // "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_GPS" - Advertiser completed
+ // partner contact form on Google Partner Search.
+ // "SMB_NO_PARTNERS_AVAILABLE_WITH_SEARCH_CRITERIA" - Advertiser saw
+ // no partners available with search criteria.
+ // "SMB_PERFORMED_SEARCH_ON_GPS" - Advertiser performed search on
+ // Google Partner Search.
+ // "SMB_VIEWED_A_PARTNER_ON_GPS" - Advertiser viewed a partner on
+ // Google Partner Search.
+ // "SMB_CANCELED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE" - Advertiser
+ // canceled partner contact form on profile page.
+ // "SMB_CLICKED_CONTACT_A_PARTNER_ON_PROFILE_PAGE" - Advertiser
+ // started partner contact form on profile page.
+ // "SMB_CLICKED_PARTNER_WEBSITE" - Advertiser clicked partner website.
+ // "SMB_COMPLETED_PARTNER_CONTACT_FORM_ON_PROFILE_PAGE" - Advertiser
+ // completed contact form on profile page.
+ // "SMB_VIEWED_A_PARTNER_PROFILE" - Advertiser viewed a partner
+ // profile.
+ // "AGENCY_CLICKED_ACCEPT_TOS_BUTTON" - Agency clicked `accept Terms
+ // Of Service` button.
+ // "AGENCY_CHANGED_TOS_COUNTRY" - Agency changed Terms Of Service
+ // country.
+ // "AGENCY_ADDED_ADDRESS_IN_MY_PROFILE_PORTAL" - Agency added address
+ // in profile portal.
+ // "AGENCY_ADDED_PHONE_NUMBER_IN_MY_PROFILE_PORTAL" - Agency added
+ // phone number in profile portal.
+ // "AGENCY_CHANGED_PRIMARY_ACCOUNT_ASSOCIATION" - Agency changed
+ // primary account association.
+ // "AGENCY_CHANGED_PRIMARY_COUNTRY_ASSOCIATION" - Agency changed
+ // primary country association.
+ // "AGENCY_CLICKED_AFFILIATE_BUTTON_IN_MY_PROFILE_IN_PORTAL" - Agency
+ // clicked `affiliate` button in profile portal.
+ // "AGENCY_CLICKED_GIVE_EDIT_ACCESS_IN_MY_PROFILE_PORTAL" - Agency
+ // clicked `give edit access` in profile portal.
+ // "AGENCY_CLICKED_LOG_OUT_IN_MY_PROFILE_PORTAL" - Agency clicked `log
+ // out` in profile portal.
+ // "AGENCY_CLICKED_MY_PROFILE_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // profile portal left nav.
+ // "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_COMPLETE_PROFILE" -
+ // Agency clicked `save and continue` at bottom of complete profile.
+ // "AGENCY_CLICKED_UNAFFILIATE_IN_MY_PROFILE_PORTAL" - Agency clicked
+ // `unaffiliate` in profile portal.
+ // "AGENCY_FILLED_OUT_COMP_AFFILIATION_IN_MY_PROFILE_PORTAL" - Agency
+ // filled out company affiliation in profile portal.
+ // "AGENCY_SUCCESSFULLY_CONNECTED_WITH_COMPANY_IN_MY_PROFILE" - Agency
+ // successfully connected with company in profile portal.
+ // "AGENCY_CLICKED_CREATE_MCC_IN_MY_PROFILE_PORTAL" - Agency clicked
+ // create MCC in profile portal.
+ // "AGENCY_DIDNT_HAVE_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE" - Agency
+ // did not have an MCC associated on profile portal.
+ // "AGENCY_HAD_AN_MCC_ASSOCIATED_ON_COMPLETE_PROFILE" - Agency had an
+ // MCC associated on profile portal.
+ // "AGENCY_ADDED_JOB_FUNCTION_IN_MY_PROFILE_PORTAL" - Agency added job
+ // function in profile portal.
+ // "AGENCY_LOOKED_AT_JOB_FUNCTION_DROP_DOWN" - Agency looked at job
+ // function drop-down.
+ // "AGENCY_SELECTED_ACCOUNT_MANAGER_AS_JOB_FUNCTION" - Agency selected
+ // `account manage` as job function.
+ // "AGENCY_SELECTED_ACCOUNT_PLANNER_AS_JOB_FUNCTION" - Agency selected
+ // `account planner` as job function.
+ // "AGENCY_SELECTED_ANALYTICS_AS_JOB_FUNCTION" - Agency selected
+ // `Analytics` as job function.
+ // "AGENCY_SELECTED_CREATIVE_AS_JOB_FUNCTION" - Agency selected
+ // `creative` as job function.
+ // "AGENCY_SELECTED_MEDIA_BUYER_AS_JOB_FUNCTION" - Agency selected
+ // `media buyer` as job function.
+ // "AGENCY_SELECTED_MEDIA_PLANNER_AS_JOB_FUNCTION" - Agency selected
+ // `media planner` as job function.
+ // "AGENCY_SELECTED_OTHER_AS_JOB_FUNCTION" - Agency selected `other`
+ // as job function.
+ // "AGENCY_SELECTED_PRODUCTION_AS_JOB_FUNCTION" - Agency selected
+ // `production` as job function.
+ // "AGENCY_SELECTED_SEO_AS_JOB_FUNCTION" - Agency selected `SEO` as
+ // job function.
+ // "AGENCY_SELECTED_SALES_REP_AS_JOB_FUNCTION" - Agency selected
+ // `sales rep` as job function.
+ // "AGENCY_SELECTED_SEARCH_SPECIALIST_AS_JOB_FUNCTION" - Agency
+ // selected `search specialist` as job function.
+ // "AGENCY_ADDED_CHANNELS_IN_MY_PROFILE_PORTAL" - Agency added
+ // channels in profile portal.
+ // "AGENCY_LOOKED_AT_ADD_CHANNEL_DROP_DOWN" - Agency looked at `add
+ // channel` drop-down.
+ // "AGENCY_SELECTED_CROSS_CHANNEL_FROM_ADD_CHANNEL" - Agency selected
+ // `cross channel` from add channel drop-down.
+ // "AGENCY_SELECTED_DISPLAY_FROM_ADD_CHANNEL" - Agency selected
+ // `display` from add channel drop-down.
+ // "AGENCY_SELECTED_MOBILE_FROM_ADD_CHANNEL" - Agency selected
+ // `mobile` from add channel drop-down.
+ // "AGENCY_SELECTED_SEARCH_FROM_ADD_CHANNEL" - Agency selected
+ // `search` from add channel drop-down.
+ // "AGENCY_SELECTED_SOCIAL_FROM_ADD_CHANNEL" - Agency selected
+ // `social` from add channel drop-down.
+ // "AGENCY_SELECTED_TOOLS_FROM_ADD_CHANNEL" - Agency selected `tools`
+ // from add channel drop-down.
+ // "AGENCY_SELECTED_YOUTUBE_FROM_ADD_CHANNEL" - Agency selected
+ // `YouTube` from add channel drop-down.
+ // "AGENCY_ADDED_INDUSTRIES_IN_MY_PROFILE_PORTAL" - Agency added
+ // industries in profile portal.
+ // "AGENCY_CHANGED_ADD_INDUSTRIES_DROP_DOWN" - Agency changed `add
+ // industries` drop-down.
+ // "AGENCY_ADDED_MARKETS_IN_MY_PROFILE_PORTAL" - Agency added markets
+ // in profile portal.
+ // "AGENCY_CHANGED_ADD_MARKETS_DROP_DOWN" - Agency changed `add
+ // markets` drop-down.
+ // "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_MYPROFILE" - Agency checked
+ // `recieve mail promotions` in profile portal.
+ // "AGENCY_CHECKED_RECIEVE_MAIL_PROMOTIONS_SIGNUP" - Agency checked
+ // `recieve mail promotions` in sign-up.
+ // "AGENCY_SELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH" - Agency
+ // selected `opt-in beta tests and market research`.
+ // "AGENCY_SELECTED_OPT_IN_BETA_TESTS_IN_MY_PROFILE_PORTAL" - Agency
+ // selected `opt-in beta tests` in profile portal.
+ // "AGENCY_SELECTED_OPT_IN_NEWS_IN_MY_PROFILE_PORTAL" - Agency
+ // selected `opt-in news` in profile portal.
+ // "AGENCY_SELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS" - Agency
+ // selected `opt-in news invitations and promotions`.
+ // "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUG_IN_MY_PROFILE_PORTAL" -
+ // Agency selected `opt-in performance SUG` in profile portal.
+ // "AGENCY_SELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS" - Agency selected
+ // `opt-in performance suggestions`.
+ // "AGENCY_SELECTED_OPT_IN_SELECT_ALL_EMAIL_NOTIFICATIONS" - Agency
+ // selected `opt-in select all email notifications`.
+ // "AGENCY_SELECTED_SELECT_ALL_OPT_INS_IN_MY_PROFILE_PORTAL" - Agency
+ // selected `select all opt-ins` in profile portal.
+ // "AGENCY_CLICKED_BACK_BUTTON_ON_CONNECT_WITH_COMPANY" - Agency
+ // clicked back button on `connect with company`.
+ // "AGENCY_CLICKED_CONTINUE_TO_OVERVIEW_ON_CONNECT_WITH_COMPANY" -
+ // Agency clicked continue to overview on `connect with company`.
+ // "AGECNY_CLICKED_CREATE_MCC_CONNECT_WITH_COMPANY_NOT_FOUND" - Agency
+ // clicked `create MCC connect with company not found`.
+ // "AGECNY_CLICKED_GIVE_EDIT_ACCESS_CONNECT_WITH_COMPANY_NOT_FOUND" -
+ // Agency clicked `give edit access connect with company not found`.
+ // "AGECNY_CLICKED_LOG_OUT_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
+ // clicked `skip for now on connect with company page`.
+ // "AGENCY_CLOSED_CONNECTED_TO_COMPANY_X_BUTTON_WRONG_COMPANY" -
+ // Agency closed connection to company.
+ // "AGENCY_COMPLETED_FIELD_CONNECT_WITH_COMPANY" - Agency completed
+ // field connect with company.
+ // "AGECNY_FOUND_COMPANY_TO_CONNECT_WITH" - Agency found company to
+ // connect with.
+ // "AGENCY_SUCCESSFULLY_CREATED_COMPANY" - Agency successfully created
+ // company.
+ // "AGENCY_ADDED_NEW_COMPANY_LOCATION" - Agency added new company
+ // location.
+ // "AGENCY_CLICKED_COMMUNITY_JOIN_NOW_LINK_IN_PORTAL_NOTIFICATIONS" -
+ // Agency clicked community `join now link` in portal notifications.
+ // "AGENCY_CLICKED_CONNECT_TO_COMPANY_LINK_IN_PORTAL_NOTIFICATIONS" -
+ // Agency clicked `connect to company` link in portal notifications.
+ // "AGENCY_CLICKED_GET_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS" -
+ // Agency cliecked `get certified` link in portal notifications.
//
// "AGENCY_CLICKED_GET_VIDEO_ADS_CERTIFIED_LINK_IN_PORTAL_NOTIFICATIONS"
- // "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS"
- // "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL"
- // "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL"
- // "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT"
- // "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED"
- // "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL"
- // "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL"
- // "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE"
- // "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE"
- // "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE"
- // "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE"
- // "AGENCY_OPENED_LAST_ADMIN_DIALOG"
- // "AGENCY_OPENED_DIALOG_WITH_NO_USERS"
- // "AGENCY_PROMOTED_USER_TO_ADMIN"
- // "AGENCY_UNAFFILIATED"
- // "AGENCY_CHANGED_ROLES"
- // "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE"
- // "SMB_VIEWED_ADWORDS_CERTIFICATE"
- // "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON"
- // "SMB_VIEWED_ANALYTICS_CERTIFICATE"
- // "SMB_VIEWED_DOUBLECLICK_CERTIFICATE"
- // "SMB_VIEWED_VIDEO_ADS_CERTIFICATE"
- // "SMB_VIEWED_SHOPPING_CERTIFICATE"
- // "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON"
- // "CLICKED_HELP_AT_BOTTOM"
- // "CLICKED_HELP_AT_TOP"
- // "CLIENT_ERROR"
- // "AGENCY_CLICKED_LEFT_NAV_STORIES"
- // "CLICKED"
- // "SMB_VIEWED_MOBILE_CERTIFICATE"
- // "AGENCY_FAILED_COMPANY_VERIFICATION"
- // "VISITED_LANDING"
- // "VISITED_GPS"
- // "VISITED_AGENCY_PORTAL"
- // "CANCELLED_INDIVIDUAL_SIGN_UP"
- // "CANCELLED_COMPANY_SIGN_UP"
- // "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP"
- // "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE"
- // "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS"
- // "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH"
- // "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS"
- // "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS"
- // "AGENCY_LINKED_INDIVIDUAL_MCC"
- // "AGENCY_SUGGESTED_TO_USER"
- // "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED"
- // "AGENCY_PICKED_SUGGESTED_AGENCY"
- // "AGENCY_SEARCHED_FOR_AGENCIES"
- // "AGENCY_PICKED_SEARCHED_AGENCY"
- // "AGENCY_DISMISSED_AFFILIATION_WIDGET"
- // "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT"
- // "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT"
- // "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON"
- // "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM"
+ // - Agency clicked `get VideoAds certified` link in portal
+ // notifications.
+ // "AGENCY_CLICKED_LINK_TO_MCC_LINK_IN_PORTAL_NOTIFICATIONS" - Agency
+ // clicked `link to MCC` link in portal notifications.
+ // "AGENCY_CLICKED_INSIGHT_CONTENT_IN_PORTAL" - Agency clicked
+ // `insight content` in portal.
+ // "AGENCY_CLICKED_INSIGHTS_VIEW_NOW_PITCH_DECKS_IN_PORTAL" - Agency
+ // clicked `insights view now pitch decks` in portal.
+ // "AGENCY_CLICKED_INSIGHTS_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // `insights` left nav in portal.
+ // "AGENCY_CLICKED_INSIGHTS_UPLOAD_CONTENT" - Agency clicked `insights
+ // upload content`.
+ // "AGENCY_CLICKED_INSIGHTS_VIEWED_DEPRECATED" - Agency clicked
+ // `insights viewed deprecated`.
+ // "AGENCY_CLICKED_COMMUNITY_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // `community` left nav in portal.
+ // "AGENCY_CLICKED_JOIN_COMMUNITY_BUTTON_COMMUNITY_PORTAL" - Agency
+ // clicked `join community` button in community portal.
+ // "AGENCY_CLICKED_CERTIFICATIONS_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // `certifications` left nav in portal.
+ // "AGENCY_CLICKED_CERTIFICATIONS_PRODUCT_LEFT_NAV_IN_PORTAL" - Agency
+ // clicked `certifications product` left nav in portal.
+ // "AGENCY_CLICKED_PARTNER_STATUS_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // `partner status` left nav in portal.
+ // "AGENCY_CLICKED_PARTNER_STATUS_PRODUCT_LEFT_NAV_IN_PORTAL" - Agency
+ // clicked `partner status product` left nav in portal.
+ // "AGENCY_CLICKED_OFFERS_LEFT_NAV_IN_PORTAL" - Agency clicked
+ // `offers` left nav in portal.
+ // "AGENCY_CLICKED_SEND_BUTTON_ON_OFFERS_PAGE" - Agency clicked `send`
+ // button on offers page.
+ // "AGENCY_CLICKED_EXAM_DETAILS_ON_CERT_ADWORDS_PAGE" - Agency clicked
+ // `exam details` on certifications AdWords page.
+ // "AGENCY_CLICKED_SEE_EXAMS_CERTIFICATION_MAIN_PAGE" - Agency clicked
+ // `see exams` certifications main page.
+ // "AGENCY_CLICKED_TAKE_EXAM_ON_CERT_EXAM_PAGE" - Agency clicked `take
+ // exam` on certifications exam page.
+ // "AGENCY_OPENED_LAST_ADMIN_DIALOG" - Agency opened `last admin`
+ // dialog.
+ // "AGENCY_OPENED_DIALOG_WITH_NO_USERS" - Agency opened dialog with no
+ // users.
+ // "AGENCY_PROMOTED_USER_TO_ADMIN" - Agency promoted user to admin.
+ // "AGENCY_UNAFFILIATED" - Agency unaffiliated.
+ // "AGENCY_CHANGED_ROLES" - Agency changed roles.
+ // "SMB_CLICKED_COMPANY_NAME_LINK_TO_PROFILE" - Advertiser clicked
+ // `company name` link to profile.
+ // "SMB_VIEWED_ADWORDS_CERTIFICATE" - Advertiser viewed AdWords
+ // certificate.
+ // "SMB_VIEWED_ADWORDS_SEARCH_CERTIFICATE" - Advertiser viewed AdWords
+ // Search certificate.
+ // "SMB_VIEWED_ADWORDS_DISPLAY_CERTIFICATE" - Advertiser viewed
+ // AdWords Display certificate.
+ // "SMB_CLICKED_ADWORDS_CERTIFICATE_HELP_ICON" - Advertiser clicked
+ // AdWords certificate help icon.
+ // "SMB_VIEWED_ANALYTICS_CERTIFICATE" - Advertiser viewed Analytics
+ // certificate.
+ // "SMB_VIEWED_DOUBLECLICK_CERTIFICATE" - Advertiser viewed
+ // DoubleClick certificate.
+ // "SMB_VIEWED_VIDEO_ADS_CERTIFICATE" - Advertiser viewed VideoAds
+ // certificate.
+ // "SMB_VIEWED_SHOPPING_CERTIFICATE" - Advertiser clicked Shopping
+ // certificate help icon.
+ // "SMB_CLICKED_VIDEO_ADS_CERTIFICATE_HELP_ICON" - Advertiser clicked
+ // VideoAds certificate help icon.
+ // "CLICKED_HELP_AT_BOTTOM" - Clicked `help` at bottom.
+ // "CLICKED_HELP_AT_TOP" - Clicked `help` at top.
+ // "CLIENT_ERROR" - Client error occurred.
+ // "AGENCY_CLICKED_LEFT_NAV_STORIES" - Agency clicked left nav
+ // `stories`.
+ // "CLICKED" - Click occured.
+ // "SMB_VIEWED_MOBILE_CERTIFICATE" - Advertiser clicked Mobile
+ // certificate help icon.
+ // "AGENCY_FAILED_COMPANY_VERIFICATION" - Agency failed the company
+ // verification.
+ // "VISITED_LANDING" - User visited the landing portion of Google
+ // Partners.
+ // "VISITED_GPS" - User visited the Google Partner Search portion of
+ // Google Partners.
+ // "VISITED_AGENCY_PORTAL" - User visited the agency portal portion of
+ // Google Partners.
+ // "CANCELLED_INDIVIDUAL_SIGN_UP" - User cancelled signing up.
+ // "CANCELLED_COMPANY_SIGN_UP" - User cancelled signing up their
+ // company.
+ // "AGENCY_CLICKED_SIGN_IN_BUTTON_TOP" - Agency clicked `Sign in` top
+ // button.
+ // "AGENCY_CLICKED_SAVE_AND_CONTINUE_AT_BOT_OF_INCOMPLETE_PROFILE" -
+ // Agency clicked `save and continue` at bottom of incomplete profile.
+ // "AGENCY_UNSELECTED_OPT_IN_NEWS_INVITATIONS_AND_PROMOS" - Agency
+ // unselected `opt-in news invitations and promotions`.
+ // "AGENCY_UNSELECTED_OPT_IN_BETA_TESTS_AND_MKT_RESEARCH" - Agency
+ // unselected `opt-in beta tests and market research`.
+ // "AGENCY_UNSELECTED_OPT_IN_PERFORMANCE_SUGGESTIONS" - Agency
+ // unselected `opt-in performance suggestions`.
+ // "AGENCY_SELECTED_OPT_OUT_UNSELECT_ALL_EMAIL_NOTIFICATIONS" - Agency
+ // selected `opt-out unselect all email notifications`.
+ // "AGENCY_LINKED_INDIVIDUAL_MCC" - Agency linked their individual
+ // MCC.
+ // "AGENCY_SUGGESTED_TO_USER" - Agency was suggested to user for
+ // affiliation.
+ // "AGENCY_IGNORED_SUGGESTED_AGENCIES_AND_SEARCHED" - Agency ignored
+ // suggested agencies and begin searching.
+ // "AGENCY_PICKED_SUGGESTED_AGENCY" - Agency picked a suggested
+ // agency.
+ // "AGENCY_SEARCHED_FOR_AGENCIES" - Agency searched for agencies.
+ // "AGENCY_PICKED_SEARCHED_AGENCY" - Agency picked a searched agency.
+ // "AGENCY_DISMISSED_AFFILIATION_WIDGET" - Agency dismissed
+ // affiliation widget.
+ // "AGENCY_CLICKED_INSIGHTS_DOWNLOAD_CONTENT" - Agency clicked on the
+ // download link for downloading content.
+ // "AGENCY_PROGRESS_INSIGHTS_VIEW_CONTENT" - Agency user is maklingg
+ // progress viewing a content item.
+ // "AGENCY_CLICKED_CANCEL_ACCEPT_TOS_BUTTON" - Agency clicked `cancel
+ // Terms Of Service` button.
+ // "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM" - Advertiser entered
+ // website in contact form.
EventAction string `json:"eventAction,omitempty"`
// EventCategory: The category the action belongs to.
//
// Possible values:
- // "EVENT_CATEGORY_UNSPECIFIED"
- // "GOOGLE_PARTNER_SEARCH"
- // "GOOGLE_PARTNER_SIGNUP_FLOW"
- // "GOOGLE_PARTNER_PORTAL"
- // "GOOGLE_PARTNER_PORTAL_MY_PROFILE"
- // "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS"
- // "GOOGLE_PARTNER_PORTAL_COMMUNITY"
- // "GOOGLE_PARTNER_PORTAL_INSIGHTS"
- // "GOOGLE_PARTNER_PORTAL_CLIENTS"
- // "GOOGLE_PARTNER_PUBLIC_USER_PROFILE"
- // "GOOGLE_PARTNER_PANEL"
- // "GOOGLE_PARTNER_PORTAL_LAST_ADMIN_DIALOG"
- // "GOOGLE_PARTNER_CLIENT"
- // "GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE"
- // "EXTERNAL_LINKS"
- // "GOOGLE_PARTNER_LANDING"
+ // "EVENT_CATEGORY_UNSPECIFIED" - Unchosen.
+ // "GOOGLE_PARTNER_SEARCH" - Google Partner Search category.
+ // "GOOGLE_PARTNER_SIGNUP_FLOW" - Google Partner sign-up flow
+ // category.
+ // "GOOGLE_PARTNER_PORTAL" - Google Partner portal category.
+ // "GOOGLE_PARTNER_PORTAL_MY_PROFILE" - Google Partner portal
+ // my-profile category.
+ // "GOOGLE_PARTNER_PORTAL_CERTIFICATIONS" - Google Partner portal
+ // certifications category.
+ // "GOOGLE_PARTNER_PORTAL_COMMUNITY" - Google Partner portal community
+ // category.
+ // "GOOGLE_PARTNER_PORTAL_INSIGHTS" - Google Partner portal insights
+ // category.
+ // "GOOGLE_PARTNER_PORTAL_CLIENTS" - Google Partner portal clients
+ // category.
+ // "GOOGLE_PARTNER_PUBLIC_USER_PROFILE" - Google Partner portal public
+ // user profile category.
+ // "GOOGLE_PARTNER_PANEL" - Google Partner panel category.
+ // "GOOGLE_PARTNER_PORTAL_LAST_ADMIN_DIALOG" - Google Partner portal
+ // last admin dialog category.
+ // "GOOGLE_PARTNER_CLIENT" - Google Partner client category.
+ // "GOOGLE_PARTNER_PORTAL_COMPANY_PROFILE" - Google Partner portal
+ // company profile category.
+ // "EXTERNAL_LINKS" - External links category.
+ // "GOOGLE_PARTNER_LANDING" - Google Partner landing category.
EventCategory string `json:"eventCategory,omitempty"`
// EventDatas: List of event data for the event.
@@ -1092,10 +2449,10 @@
// EventScope: The scope of the event.
//
// Possible values:
- // "EVENT_SCOPE_UNSPECIFIED"
- // "VISITOR"
- // "SESSION"
- // "PAGE"
+ // "EVENT_SCOPE_UNSPECIFIED" - Unchosen.
+ // "VISITOR" - Based on visitor.
+ // "SESSION" - Based on session.
+ // "PAGE" - Based on page visit.
EventScope string `json:"eventScope,omitempty"`
// Lead: Advertiser lead information.
@@ -1130,7 +2487,8 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// LogUserEventResponse: Response message for LogUserEvent.
+// LogUserEventResponse: Response message for
+// LogUserEvent.
type LogUserEventResponse struct {
// ResponseMetadata: Current response metadata.
ResponseMetadata *ResponseMetadata `json:"responseMetadata,omitempty"`
@@ -1168,16 +2526,18 @@
// CurrencyCode: The 3-letter currency code defined in ISO 4217.
CurrencyCode string `json:"currencyCode,omitempty"`
- // Nanos: Number of nano (10^-9) units of the amount. The value must be
- // between -999,999,999 and +999,999,999 inclusive. If `units` is
- // positive, `nanos` must be positive or zero. If `units` is zero,
- // `nanos` can be positive, zero, or negative. If `units` is negative,
- // `nanos` must be negative or zero. For example $-1.75 is represented
- // as `units`=-1 and `nanos`=-750,000,000.
+ // Nanos: Number of nano (10^-9) units of the amount.
+ // The value must be between -999,999,999 and +999,999,999 inclusive.
+ // If `units` is positive, `nanos` must be positive or zero.
+ // If `units` is zero, `nanos` can be positive, zero, or negative.
+ // If `units` is negative, `nanos` must be negative or zero.
+ // For example $-1.75 is represented as `units`=-1 and
+ // `nanos`=-750,000,000.
Nanos int64 `json:"nanos,omitempty"`
- // Units: The whole units of the amount. For example if `currencyCode`
- // is "USD", then 1 unit is one US dollar.
+ // Units: The whole units of the amount.
+ // For example if `currencyCode` is "USD", then 1 unit is one US
+ // dollar.
Units int64 `json:"units,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "CurrencyCode") to
@@ -1203,10 +2563,116 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// OfferCustomer: Customers qualified for an offer.
+type OfferCustomer struct {
+ // AdwordsUrl: URL to the customer's AdWords page.
+ AdwordsUrl string `json:"adwordsUrl,omitempty"`
+
+ // CountryCode: Country code of the customer.
+ CountryCode string `json:"countryCode,omitempty"`
+
+ // CreationTime: Time the customer was created.
+ CreationTime string `json:"creationTime,omitempty"`
+
+ // EligibilityDaysLeft: Days the customer is still eligible.
+ EligibilityDaysLeft int64 `json:"eligibilityDaysLeft,omitempty"`
+
+ // ExternalCid: External CID for the customer.
+ ExternalCid int64 `json:"externalCid,omitempty,string"`
+
+ // GetYAmount: Formatted Get Y amount with currency code.
+ GetYAmount string `json:"getYAmount,omitempty"`
+
+ // Name: Name of the customer.
+ Name string `json:"name,omitempty"`
+
+ // OfferType: Type of the offer
+ //
+ // Possible values:
+ // "OFFER_TYPE_UNSPECIFIED" - Unset.
+ // "OFFER_TYPE_SPEND_X_GET_Y" - AdWords spend X get Y.
+ // "OFFER_TYPE_VIDEO" - Youtube video.
+ // "OFFER_TYPE_SPEND_MATCH" - Spend Match up to Y.
+ OfferType string `json:"offerType,omitempty"`
+
+ // SpendXAmount: Formatted Spend X amount with currency code.
+ SpendXAmount string `json:"spendXAmount,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "AdwordsUrl") 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. "AdwordsUrl") 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 *OfferCustomer) MarshalJSON() ([]byte, error) {
+ type noMethod OfferCustomer
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// OptIns: A set of opt-ins for a user.
+type OptIns struct {
+ // MarketComm: An opt-in about receiving email from Partners marketing
+ // teams. Includes
+ // member-only events and special promotional offers for Google
+ // products.
+ MarketComm bool `json:"marketComm,omitempty"`
+
+ // PerformanceSuggestions: An opt-in about receiving email with
+ // customized AdWords campaign management
+ // tips.
+ PerformanceSuggestions bool `json:"performanceSuggestions,omitempty"`
+
+ // PhoneContact: An opt-in to allow recieivng phone calls about their
+ // Partners account.
+ PhoneContact bool `json:"phoneContact,omitempty"`
+
+ // PhysicalMail: An opt-in to receive special promotional gifts and
+ // material in the mail.
+ PhysicalMail bool `json:"physicalMail,omitempty"`
+
+ // SpecialOffers: An opt-in about receiving email regarding new features
+ // and products.
+ SpecialOffers bool `json:"specialOffers,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "MarketComm") 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. "MarketComm") 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 *OptIns) MarshalJSON() ([]byte, error) {
+ type noMethod OptIns
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// PublicProfile: Basic information from a public profile.
type PublicProfile struct {
// DisplayImageUrl: The URL to the main display image of the public
- // profile.
+ // profile. Being deprecated.
DisplayImageUrl string `json:"displayImageUrl,omitempty"`
// DisplayName: The display name of the public profile.
@@ -1216,6 +2682,10 @@
// public profile.
Id string `json:"id,omitempty"`
+ // ProfileImage: The URL to the main profile image of the public
+ // profile.
+ ProfileImage string `json:"profileImage,omitempty"`
+
// Url: The URL of the public profile.
Url string `json:"url,omitempty"`
@@ -1248,8 +2718,8 @@
// Type: The type of rank.
//
// Possible values:
- // "RANK_TYPE_UNSPECIFIED"
- // "RT_FINAL_SCORE"
+ // "RANK_TYPE_UNSPECIFIED" - Unchosen.
+ // "RT_FINAL_SCORE" - Total final score.
Type string `json:"type,omitempty"`
// Value: The numerical value of the rank.
@@ -1292,7 +2762,9 @@
return nil
}
-// RecaptchaChallenge: reCaptcha challenge info.
+// RecaptchaChallenge: <a
+// href="https://www.google.com/recaptcha/">reCaptcha</a> challenge
+// info.
type RecaptchaChallenge struct {
// Id: The ID of the reCaptcha challenge.
Id string `json:"id,omitempty"`
@@ -1338,8 +2810,8 @@
TrafficSource *TrafficSource `json:"trafficSource,omitempty"`
// UserOverrides: Values to use instead of the user's respective
- // defaults for the current request. These are only honored by
- // whitelisted products.
+ // defaults for the current
+ // request. These are only honored by whitelisted products.
UserOverrides *UserOverrides `json:"userOverrides,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExperimentIds") to
@@ -1393,16 +2865,70 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// SpecializationStatus: Agency specialization status
+type SpecializationStatus struct {
+ // BadgeSpecialization: The specialization this status is for.
+ //
+ // Possible values:
+ // "BADGE_SPECIALIZATION_UNKNOWN" - Unknown specialization
+ // "BADGE_SPECIALIZATION_ADWORDS_SEARCH" - AdWords Search
+ // specialization
+ // "BADGE_SPECIALIZATION_ADWORDS_DISPLAY" - AdWords Display
+ // specialization
+ // "BADGE_SPECIALIZATION_ADWORDS_MOBILE" - AdWords Mobile
+ // specialization
+ // "BADGE_SPECIALIZATION_ADWORDS_VIDEO" - AdWords Video specialization
+ // "BADGE_SPECIALIZATION_ADWORDS_SHOPPING" - AdWords Shopping
+ // specialization
+ BadgeSpecialization string `json:"badgeSpecialization,omitempty"`
+
+ // BadgeSpecializationState: State of agency specialization.
+ //
+ // Possible values:
+ // "BADGE_SPECIALIZATION_STATE_UNKNOWN" - Unknown state
+ // "BADGE_SPECIALIZATION_STATE_PASSED" - Specialization passed
+ // "BADGE_SPECIALIZATION_STATE_NOT_PASSED" - Specialization not passed
+ // "BADGE_SPECIALIZATION_STATE_IN_GRACE" - Specialization in grace
+ BadgeSpecializationState string `json:"badgeSpecializationState,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "BadgeSpecialization")
+ // 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. "BadgeSpecialization") 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 *SpecializationStatus) MarshalJSON() ([]byte, error) {
+ type noMethod SpecializationStatus
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// TrafficSource: Source of traffic for the current request.
type TrafficSource struct {
- // TrafficSourceId: Identifier to indicate where the traffic comes from.
+ // TrafficSourceId: Identifier to indicate where the traffic comes
+ // from.
// An identifier has multiple letters created by a team which redirected
- // the traffic to us.
+ // the
+ // traffic to us.
TrafficSourceId string `json:"trafficSourceId,omitempty"`
// TrafficSubId: Second level identifier to indicate where the traffic
- // comes from. An identifier has multiple letters created by a team
- // which redirected the traffic to us.
+ // comes from.
+ // An identifier has multiple letters created by a team which redirected
+ // the
+ // traffic to us.
TrafficSubId string `json:"trafficSubId,omitempty"`
// ForceSendFields is a list of field names (e.g. "TrafficSourceId") to
@@ -1429,8 +2955,92 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// User: A resource representing a user of the Partners platform.
+type User struct {
+ // AvailableAdwordsManagerAccounts: This is the list of AdWords Manager
+ // Accounts the user has edit access to.
+ // If the user has edit access to multiple accounts, the user can choose
+ // the
+ // preferred account and we use this when a personal account is needed.
+ // Can
+ // be empty meaning the user has access to no accounts.
+ // @OutputOnly
+ AvailableAdwordsManagerAccounts []*AdWordsManagerAccountInfo `json:"availableAdwordsManagerAccounts,omitempty"`
+
+ // CertificationStatus: The list of achieved certifications. These are
+ // calculated based on exam
+ // results and other requirements.
+ // @OutputOnly
+ CertificationStatus []*Certification `json:"certificationStatus,omitempty"`
+
+ // Company: The company that the user is associated with.
+ // If not present, the user is not associated with any company.
+ Company *CompanyRelation `json:"company,omitempty"`
+
+ // CompanyVerificationEmail: The email address used by the user used for
+ // company verification.
+ // @OutputOnly
+ CompanyVerificationEmail string `json:"companyVerificationEmail,omitempty"`
+
+ // ExamStatus: The list of exams the user ever taken. For each type of
+ // exam, only one
+ // entry is listed.
+ ExamStatus []*ExamStatus `json:"examStatus,omitempty"`
+
+ // Id: The ID of the user.
+ Id string `json:"id,omitempty"`
+
+ // LastAccessTime: The most recent time the user interacted with the
+ // Partners site.
+ // @OutputOnly
+ LastAccessTime string `json:"lastAccessTime,omitempty"`
+
+ // PrimaryEmails: The list of emails the user has access to/can select
+ // as primary.
+ // @OutputOnly
+ PrimaryEmails []string `json:"primaryEmails,omitempty"`
+
+ // Profile: The profile information of a Partners user, contains all the
+ // directly
+ // editable user information.
+ Profile *UserProfile `json:"profile,omitempty"`
+
+ // PublicProfile: Information about a user's external public profile
+ // outside Google Partners.
+ PublicProfile *PublicProfile `json:"publicProfile,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g.
+ // "AvailableAdwordsManagerAccounts") 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.
+ // "AvailableAdwordsManagerAccounts") 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 *User) MarshalJSON() ([]byte, error) {
+ type noMethod User
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// UserOverrides: Values to use instead of the user's respective
-// defaults. These are only honored by whitelisted products.
+// defaults. These are only
+// honored by whitelisted products.
type UserOverrides struct {
// IpAddress: IP address to use instead of the user's geo-located IP
// address.
@@ -1462,6 +3072,372 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// UserProfile: The profile information of a Partners user.
+type UserProfile struct {
+ // Address: The user's mailing address, contains multiple fields.
+ Address *Location `json:"address,omitempty"`
+
+ // AdwordsManagerAccount: If the user has edit access to multiple
+ // accounts, the user can choose the
+ // preferred account and it is used when a personal account is needed.
+ // Can
+ // be empty.
+ AdwordsManagerAccount int64 `json:"adwordsManagerAccount,omitempty,string"`
+
+ // Channels: A list of ids representing which channels the user selected
+ // they were in.
+ Channels []string `json:"channels,omitempty"`
+
+ // EmailAddress: The email address the user has selected on the Partners
+ // site as primary.
+ EmailAddress string `json:"emailAddress,omitempty"`
+
+ // EmailOptIns: The list of opt-ins for the user, related to
+ // communication preferences.
+ EmailOptIns *OptIns `json:"emailOptIns,omitempty"`
+
+ // FamilyName: The user's family name.
+ FamilyName string `json:"familyName,omitempty"`
+
+ // GivenName: The user's given name.
+ GivenName string `json:"givenName,omitempty"`
+
+ // Industries: A list of ids representing which industries the user
+ // selected.
+ Industries []string `json:"industries,omitempty"`
+
+ // JobFunctions: A list of ids represnting which job categories the user
+ // selected.
+ JobFunctions []string `json:"jobFunctions,omitempty"`
+
+ // Languages: The list of languages this user understands.
+ Languages []string `json:"languages,omitempty"`
+
+ // Markets: A list of ids representing which markets the user was
+ // interested in.
+ Markets []string `json:"markets,omitempty"`
+
+ // PhoneNumber: The user's phone number.
+ PhoneNumber string `json:"phoneNumber,omitempty"`
+
+ // PrimaryCountryCode: The user's primary country, an ISO 2-character
+ // code.
+ PrimaryCountryCode string `json:"primaryCountryCode,omitempty"`
+
+ // ProfilePublic: Whether the user's public profile is visible to anyone
+ // with the URL.
+ ProfilePublic bool `json:"profilePublic,omitempty"`
+
+ // ServerResponse contains the HTTP response code and headers from the
+ // server.
+ googleapi.ServerResponse `json:"-"`
+
+ // ForceSendFields is a list of field names (e.g. "Address") 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. "Address") 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 *UserProfile) MarshalJSON() ([]byte, error) {
+ type noMethod UserProfile
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
+// method id "partners.analytics.list":
+
+type AnalyticsListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists analytics data for a user's associated company.
+// Should only be called within the context of an authorized logged in
+// user.
+func (r *AnalyticsService) List() *AnalyticsListCall {
+ c := &AnalyticsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Requested page size.
+// Server may return fewer analytics than requested.
+// If unspecified or set to 0, default value is 30.
+// Specifies the number of days in the date range when querying
+// analytics.
+// The `page_token` represents the end date of the date range
+// and the start date is calculated using the `page_size` as the
+// number
+// of days BEFORE the end date.
+// Must be a non-negative integer.
+func (c *AnalyticsListCall) PageSize(pageSize int64) *AnalyticsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A token
+// identifying a page of results that the server returns.
+// Typically, this is the value of
+// `ListAnalyticsResponse.next_page_token`
+// returned from the previous call to
+// ListAnalytics.
+// Will be a date string in `YYYY-MM-DD` format representing the end
+// date
+// of the date range of results to return.
+// If unspecified or set to "", default value is the current date.
+func (c *AnalyticsListCall) PageToken(pageToken string) *AnalyticsListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *AnalyticsListCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *AnalyticsListCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *AnalyticsListCall) RequestMetadataLocale(requestMetadataLocale string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *AnalyticsListCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *AnalyticsListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *AnalyticsListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *AnalyticsListCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *AnalyticsListCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *AnalyticsListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *AnalyticsListCall) Fields(s ...googleapi.Field) *AnalyticsListCall {
+ 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 *AnalyticsListCall) IfNoneMatch(entityTag string) *AnalyticsListCall {
+ 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 *AnalyticsListCall) Context(ctx context.Context) *AnalyticsListCall {
+ 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 *AnalyticsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *AnalyticsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/analytics")
+ 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 "partners.analytics.list" call.
+// Exactly one of *ListAnalyticsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListAnalyticsResponse.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 *AnalyticsListCall) Do(opts ...googleapi.CallOption) (*ListAnalyticsResponse, 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 := &ListAnalyticsResponse{
+ 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 analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ // "flatPath": "v2/analytics",
+ // "httpMethod": "GET",
+ // "id": "partners.analytics.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "pageSize": {
+ // "description": "Requested page size. Server may return fewer analytics than requested.\nIf unspecified or set to 0, default value is 30.\nSpecifies the number of days in the date range when querying analytics.\nThe `page_token` represents the end date of the date range\nand the start date is calculated using the `page_size` as the number\nof days BEFORE the end date.\nMust be a non-negative integer.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/analytics",
+ // "response": {
+ // "$ref": "ListAnalyticsResponse"
+ // }
+ // }
+
+}
+
+// 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 *AnalyticsListCall) Pages(ctx context.Context, f func(*ListAnalyticsResponse) 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 "partners.clientMessages.log":
type ClientMessagesLogCall struct {
@@ -1472,9 +3448,9 @@
header_ http.Header
}
-// Log: Logs a generic message from the client, such as `Failed to
-// render component`, `Profile page is running slow`, `More than 500
-// users have accessed this result.`, etc.
+// Log: Logs a generic message from the client, such as
+// `Failed to render component`, `Profile page is running slow`,
+// `More than 500 users have accessed this result.`, etc.
func (r *ClientMessagesService) Log(logmessagerequest *LogMessageRequest) *ClientMessagesLogCall {
c := &ClientMessagesLogCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.logmessagerequest = logmessagerequest
@@ -1565,9 +3541,12 @@
}
return ret, nil
// {
- // "description": "Logs a generic message from the client, such as `Failed to render component`, `Profile page is running slow`, `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.",
+ // "flatPath": "v2/clientMessages:log",
// "httpMethod": "POST",
// "id": "partners.clientMessages.log",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v2/clientMessages:log",
// "request": {
// "$ref": "LogMessageRequest"
@@ -1598,16 +3577,17 @@
}
// Address sets the optional parameter "address": The address to use for
-// sorting the company's addresses by proximity. If not given, the
-// geo-located address of the request is used. Used when order_by is
-// set.
+// sorting the company's addresses by proximity.
+// If not given, the geo-located address of the request is used.
+// Used when order_by is set.
func (c *CompaniesGetCall) Address(address string) *CompaniesGetCall {
c.urlParams_.Set("address", address)
return c
}
// CurrencyCode sets the optional parameter "currencyCode": If the
-// company's budget is in a different currency code than this one, then
+// company's budget is in a different currency code than this one,
+// then
// the converted budget is converted to this currency code.
func (c *CompaniesGetCall) CurrencyCode(currencyCode string) *CompaniesGetCall {
c.urlParams_.Set("currencyCode", currencyCode)
@@ -1615,10 +3595,12 @@
}
// OrderBy sets the optional parameter "orderBy": How to order addresses
-// within the returned company. Currently, only `address` and `address
-// desc` is supported which will sorted by closest to farthest in
-// distance from given address and farthest to closest distance from
-// given address respectively.
+// within the returned company. Currently, only
+// `address` and `address desc` is supported which will sorted by
+// closest to
+// farthest in distance from given address and farthest to closest
+// distance
+// from given address respectively.
func (c *CompaniesGetCall) OrderBy(orderBy string) *CompaniesGetCall {
c.urlParams_.Set("orderBy", orderBy)
return c
@@ -1648,8 +3630,10 @@
// RequestMetadataTrafficSourceTrafficSourceId sets the optional
// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *CompaniesGetCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *CompaniesGetCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
return c
@@ -1657,8 +3641,10 @@
// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
// "requestMetadata.trafficSource.trafficSubId": Second level identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *CompaniesGetCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *CompaniesGetCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
return c
@@ -1681,7 +3667,8 @@
}
// View sets the optional parameter "view": The view of `Company`
-// resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
+// resource to be returned. This must not be
+// `COMPANY_VIEW_UNSPECIFIED`.
//
// Possible values:
// "COMPANY_VIEW_UNSPECIFIED"
@@ -1787,6 +3774,7 @@
return ret, nil
// {
// "description": "Gets a company.",
+ // "flatPath": "v2/companies/{companyId}",
// "httpMethod": "GET",
// "id": "partners.companies.get",
// "parameterOrder": [
@@ -1794,7 +3782,7 @@
// ],
// "parameters": {
// "address": {
- // "description": "The address to use for sorting the company's addresses by proximity. If not given, the geo-located address of the request is used. Used when order_by is set.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
@@ -1805,12 +3793,12 @@
// "type": "string"
// },
// "currencyCode": {
- // "description": "If the company's budget is in a different currency code than this one, then the converted budget is converted to this currency code.",
+ // "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",
// "type": "string"
// },
// "orderBy": {
- // "description": "How to order addresses within the returned company. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.",
+ // "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.",
// "location": "query",
// "type": "string"
// },
@@ -1831,12 +3819,12 @@
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSourceId": {
- // "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
+ // "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",
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSubId": {
- // "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic 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.",
// "location": "query",
// "type": "string"
// },
@@ -1851,7 +3839,7 @@
// "type": "string"
// },
// "view": {
- // "description": "The view of `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.",
+ // "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
// "enum": [
// "COMPANY_VIEW_UNSPECIFIED",
// "CV_GOOGLE_PARTNER_SEARCH"
@@ -1885,8 +3873,8 @@
}
// Address sets the optional parameter "address": The address to use
-// when searching for companies. If not given, the geo-located address
-// of the request is used.
+// when searching for companies.
+// If not given, the geo-located address of the request is used.
func (c *CompaniesListCall) Address(address string) *CompaniesListCall {
c.urlParams_.Set("address", address)
return c
@@ -1933,9 +3921,11 @@
}
// LanguageCodes sets the optional parameter "languageCodes": List of
-// language codes that company can support. Only primary language
-// subtags are accepted as defined by BCP 47 (IETF BCP 47, "Tags for
-// Identifying Languages").
+// language codes that company can support. Only primary
+// language
+// subtags are accepted as defined by
+// <a href="https://tools.ietf.org/html/bcp47">BCP 47</a>
+// (IETF BCP 47, "Tags for Identifying Languages").
func (c *CompaniesListCall) LanguageCodes(languageCodes ...string) *CompaniesListCall {
c.urlParams_.SetMulti("languageCodes", append([]string{}, languageCodes...))
return c
@@ -1950,20 +3940,23 @@
}
// MaxMonthlyBudgetNanos sets the optional parameter
-// "maxMonthlyBudget.nanos": Number of nano (10^-9) units of the amount.
-// The value must be between -999,999,999 and +999,999,999 inclusive. If
-// `units` is positive, `nanos` must be positive or zero. If `units` is
-// zero, `nanos` can be positive, zero, or negative. If `units` is
-// negative, `nanos` must be negative or zero. For example $-1.75 is
-// represented as `units`=-1 and `nanos`=-750,000,000.
+// "maxMonthlyBudget.nanos": Number of nano (10^-9) units of the
+// amount.
+// The value must be between -999,999,999 and +999,999,999 inclusive.
+// If `units` is positive, `nanos` must be positive or zero.
+// If `units` is zero, `nanos` can be positive, zero, or negative.
+// If `units` is negative, `nanos` must be negative or zero.
+// For example $-1.75 is represented as `units`=-1 and
+// `nanos`=-750,000,000.
func (c *CompaniesListCall) MaxMonthlyBudgetNanos(maxMonthlyBudgetNanos int64) *CompaniesListCall {
c.urlParams_.Set("maxMonthlyBudget.nanos", fmt.Sprint(maxMonthlyBudgetNanos))
return c
}
// MaxMonthlyBudgetUnits sets the optional parameter
-// "maxMonthlyBudget.units": The whole units of the amount. For example
-// if `currencyCode` is "USD", then 1 unit is one US dollar.
+// "maxMonthlyBudget.units": The whole units of the amount.
+// For example if `currencyCode` is "USD", then 1 unit is one US
+// dollar.
func (c *CompaniesListCall) MaxMonthlyBudgetUnits(maxMonthlyBudgetUnits int64) *CompaniesListCall {
c.urlParams_.Set("maxMonthlyBudget.units", fmt.Sprint(maxMonthlyBudgetUnits))
return c
@@ -1978,47 +3971,54 @@
}
// MinMonthlyBudgetNanos sets the optional parameter
-// "minMonthlyBudget.nanos": Number of nano (10^-9) units of the amount.
-// The value must be between -999,999,999 and +999,999,999 inclusive. If
-// `units` is positive, `nanos` must be positive or zero. If `units` is
-// zero, `nanos` can be positive, zero, or negative. If `units` is
-// negative, `nanos` must be negative or zero. For example $-1.75 is
-// represented as `units`=-1 and `nanos`=-750,000,000.
+// "minMonthlyBudget.nanos": Number of nano (10^-9) units of the
+// amount.
+// The value must be between -999,999,999 and +999,999,999 inclusive.
+// If `units` is positive, `nanos` must be positive or zero.
+// If `units` is zero, `nanos` can be positive, zero, or negative.
+// If `units` is negative, `nanos` must be negative or zero.
+// For example $-1.75 is represented as `units`=-1 and
+// `nanos`=-750,000,000.
func (c *CompaniesListCall) MinMonthlyBudgetNanos(minMonthlyBudgetNanos int64) *CompaniesListCall {
c.urlParams_.Set("minMonthlyBudget.nanos", fmt.Sprint(minMonthlyBudgetNanos))
return c
}
// MinMonthlyBudgetUnits sets the optional parameter
-// "minMonthlyBudget.units": The whole units of the amount. For example
-// if `currencyCode` is "USD", then 1 unit is one US dollar.
+// "minMonthlyBudget.units": The whole units of the amount.
+// For example if `currencyCode` is "USD", then 1 unit is one US
+// dollar.
func (c *CompaniesListCall) MinMonthlyBudgetUnits(minMonthlyBudgetUnits int64) *CompaniesListCall {
c.urlParams_.Set("minMonthlyBudget.units", fmt.Sprint(minMonthlyBudgetUnits))
return c
}
// OrderBy sets the optional parameter "orderBy": How to order addresses
-// within the returned companies. Currently, only `address` and `address
-// desc` is supported which will sorted by closest to farthest in
-// distance from given address and farthest to closest distance from
-// given address respectively.
+// within the returned companies. Currently, only
+// `address` and `address desc` is supported which will sorted by
+// closest to
+// farthest in distance from given address and farthest to closest
+// distance
+// from given address respectively.
func (c *CompaniesListCall) OrderBy(orderBy string) *CompaniesListCall {
c.urlParams_.Set("orderBy", orderBy)
return c
}
// PageSize sets the optional parameter "pageSize": Requested page size.
-// Server may return fewer companies than requested. If unspecified,
-// server picks an appropriate default.
+// Server may return fewer companies than requested.
+// If unspecified, server picks an appropriate default.
func (c *CompaniesListCall) PageSize(pageSize int64) *CompaniesListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
// PageToken sets the optional parameter "pageToken": A token
-// identifying a page of results that the server returns. Typically,
-// this is the value of `ListCompaniesResponse.next_page_token` returned
-// from the previous call to ListCompanies.
+// identifying a page of results that the server returns.
+// Typically, this is the value of
+// `ListCompaniesResponse.next_page_token`
+// returned from the previous call to
+// ListCompanies.
func (c *CompaniesListCall) PageToken(pageToken string) *CompaniesListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
@@ -2048,8 +4048,10 @@
// RequestMetadataTrafficSourceTrafficSourceId sets the optional
// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *CompaniesListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *CompaniesListCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
return c
@@ -2057,8 +4059,10 @@
// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
// "requestMetadata.trafficSource.trafficSubId": Second level identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *CompaniesListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *CompaniesListCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
return c
@@ -2080,8 +4084,11 @@
return c
}
-// Services sets the optional parameter "services": List of services the
-// company can help with.
+// Services sets the optional parameter "services": List of services
+// that the returned agencies should provide. If this is
+// not empty, any returned agency must have at least one of these
+// services,
+// or one of the specializations in the "specializations" field.
//
// Possible values:
// "SERVICE_UNSPECIFIED"
@@ -2090,13 +4097,34 @@
// "S_AN_ENHANCED_WEBSITE"
// "S_AN_ONLINE_MARKETING_PLAN"
// "S_MOBILE_AND_VIDEO_ADS"
+// "S_MOBILE_WEBSITE_SERVICES"
func (c *CompaniesListCall) Services(services ...string) *CompaniesListCall {
c.urlParams_.SetMulti("services", append([]string{}, services...))
return c
}
+// Specializations sets the optional parameter "specializations": List
+// of specializations that the returned agencies should provide. If
+// this
+// is not empty, any returned agency must have at least one of
+// these
+// specializations, or one of the services in the "services" field.
+//
+// Possible values:
+// "BADGE_SPECIALIZATION_UNKNOWN"
+// "BADGE_SPECIALIZATION_ADWORDS_SEARCH"
+// "BADGE_SPECIALIZATION_ADWORDS_DISPLAY"
+// "BADGE_SPECIALIZATION_ADWORDS_MOBILE"
+// "BADGE_SPECIALIZATION_ADWORDS_VIDEO"
+// "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
+func (c *CompaniesListCall) Specializations(specializations ...string) *CompaniesListCall {
+ c.urlParams_.SetMulti("specializations", append([]string{}, specializations...))
+ return c
+}
+
// View sets the optional parameter "view": The view of the `Company`
-// resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.
+// resource to be returned. This must not be
+// `COMPANY_VIEW_UNSPECIFIED`.
//
// Possible values:
// "COMPANY_VIEW_UNSPECIFIED"
@@ -2107,7 +4135,8 @@
}
// WebsiteUrl sets the optional parameter "websiteUrl": Website URL that
-// will help to find a better matched company. .
+// will help to find a better matched company.
+// .
func (c *CompaniesListCall) WebsiteUrl(websiteUrl string) *CompaniesListCall {
c.urlParams_.Set("websiteUrl", websiteUrl)
return c
@@ -2206,11 +4235,13 @@
return ret, nil
// {
// "description": "Lists companies.",
+ // "flatPath": "v2/companies",
// "httpMethod": "GET",
// "id": "partners.companies.list",
+ // "parameterOrder": [],
// "parameters": {
// "address": {
- // "description": "The address to use when searching for companies. If not given, the geo-located address of the request is used.",
+ // "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.",
// "location": "query",
// "type": "string"
// },
@@ -2251,7 +4282,7 @@
// "type": "string"
// },
// "languageCodes": {
- // "description": "List of language codes that company can support. Only primary language subtags are accepted as defined by BCP 47 (IETF BCP 47, \"Tags for Identifying Languages\").",
+ // "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\").",
// "location": "query",
// "repeated": true,
// "type": "string"
@@ -2262,13 +4293,13 @@
// "type": "string"
// },
// "maxMonthlyBudget.nanos": {
- // "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ // "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "maxMonthlyBudget.units": {
- // "description": "The whole units of the amount. For 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.",
// "format": "int64",
// "location": "query",
// "type": "string"
@@ -2279,30 +4310,30 @@
// "type": "string"
// },
// "minMonthlyBudget.nanos": {
- // "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ // "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "minMonthlyBudget.units": {
- // "description": "The whole units of the amount. For 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.",
// "format": "int64",
// "location": "query",
// "type": "string"
// },
// "orderBy": {
- // "description": "How to order addresses within the returned companies. Currently, only `address` and `address desc` is supported which will sorted by closest to farthest in distance from given address and farthest to closest distance from given address respectively.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
// "pageSize": {
- // "description": "Requested page size. Server may return fewer companies than requested. If unspecified, server picks an appropriate default.",
+ // "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "A token identifying a page of results that the server returns. Typically, this is the value of `ListCompaniesResponse.next_page_token` returned from the previous call to ListCompanies.",
+ // "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",
// "type": "string"
// },
@@ -2323,12 +4354,12 @@
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSourceId": {
- // "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
+ // "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",
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSubId": {
- // "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic 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.",
// "location": "query",
// "type": "string"
// },
@@ -2343,21 +4374,36 @@
// "type": "string"
// },
// "services": {
- // "description": "List of services the company can help with.",
+ // "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.",
// "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_AND_VIDEO_ADS",
+ // "S_MOBILE_WEBSITE_SERVICES"
+ // ],
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "specializations": {
+ // "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.",
+ // "enum": [
+ // "BADGE_SPECIALIZATION_UNKNOWN",
+ // "BADGE_SPECIALIZATION_ADWORDS_SEARCH",
+ // "BADGE_SPECIALIZATION_ADWORDS_DISPLAY",
+ // "BADGE_SPECIALIZATION_ADWORDS_MOBILE",
+ // "BADGE_SPECIALIZATION_ADWORDS_VIDEO",
+ // "BADGE_SPECIALIZATION_ADWORDS_SHOPPING"
// ],
// "location": "query",
// "repeated": true,
// "type": "string"
// },
// "view": {
- // "description": "The view of the `Company` resource to be returned. This must not be `COMPANY_VIEW_UNSPECIFIED`.",
+ // "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.",
// "enum": [
// "COMPANY_VIEW_UNSPECIFIED",
// "CV_GOOGLE_PARTNER_SEARCH"
@@ -2366,7 +4412,7 @@
// "type": "string"
// },
// "websiteUrl": {
- // "description": "Website URL that will help to find a better matched company. .",
+ // "description": "Website URL that will help to find a better matched company.\n.",
// "location": "query",
// "type": "string"
// }
@@ -2507,6 +4553,7 @@
return ret, nil
// {
// "description": "Creates an advertiser lead for the given company ID.",
+ // "flatPath": "v2/companies/{companyId}/leads",
// "httpMethod": "POST",
// "id": "partners.companies.leads.create",
// "parameterOrder": [
@@ -2531,6 +4578,1051 @@
}
+// method id "partners.exams.getToken":
+
+type ExamsGetTokenCall struct {
+ s *Service
+ examType string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetToken: Gets an Exam Token for a Partner's user to take an exam in
+// the Exams System
+func (r *ExamsService) GetToken(examType string) *ExamsGetTokenCall {
+ c := &ExamsGetTokenCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.examType = examType
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *ExamsGetTokenCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *ExamsGetTokenCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *ExamsGetTokenCall) RequestMetadataLocale(requestMetadataLocale string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *ExamsGetTokenCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *ExamsGetTokenCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *ExamsGetTokenCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *ExamsGetTokenCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *ExamsGetTokenCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *ExamsGetTokenCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *ExamsGetTokenCall) Fields(s ...googleapi.Field) *ExamsGetTokenCall {
+ 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 *ExamsGetTokenCall) IfNoneMatch(entityTag string) *ExamsGetTokenCall {
+ 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 *ExamsGetTokenCall) Context(ctx context.Context) *ExamsGetTokenCall {
+ 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 *ExamsGetTokenCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *ExamsGetTokenCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/exams/{examType}/token")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "examType": c.examType,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.exams.getToken" call.
+// Exactly one of *ExamToken or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *ExamToken.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 *ExamsGetTokenCall) Do(opts ...googleapi.CallOption) (*ExamToken, 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 := &ExamToken{
+ 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 an Exam Token for a Partner's user to take an exam in the Exams System",
+ // "flatPath": "v2/exams/{examType}/token",
+ // "httpMethod": "GET",
+ // "id": "partners.exams.getToken",
+ // "parameterOrder": [
+ // "examType"
+ // ],
+ // "parameters": {
+ // "examType": {
+ // "description": "The exam type we are requesting a token for.",
+ // "enum": [
+ // "CERTIFICATION_EXAM_TYPE_UNSPECIFIED",
+ // "CET_ADWORDS_FUNDAMENTALS",
+ // "CET_ADWORDS_ADVANCED_SEARCH",
+ // "CET_ADWORDS_ADVANCED_DISPLAY",
+ // "CET_VIDEO_ADS",
+ // "CET_DOUBLECLICK",
+ // "CET_ANALYTICS",
+ // "CET_SHOPPING",
+ // "CET_MOBILE",
+ // "CET_DIGITAL_SALES",
+ // "CET_MOBILE_SITES"
+ // ],
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/exams/{examType}/token",
+ // "response": {
+ // "$ref": "ExamToken"
+ // }
+ // }
+
+}
+
+// method id "partners.leads.list":
+
+type LeadsListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists advertiser leads for a user's associated company.
+// Should only be called within the context of an authorized logged in
+// user.
+func (r *LeadsService) List() *LeadsListCall {
+ c := &LeadsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// OrderBy sets the optional parameter "orderBy": How to order Leads.
+// Currently, only `create_time`
+// and `create_time desc` are supported
+func (c *LeadsListCall) OrderBy(orderBy string) *LeadsListCall {
+ c.urlParams_.Set("orderBy", orderBy)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Requested page size.
+// Server may return fewer leads than requested.
+// If unspecified, server picks an appropriate default.
+func (c *LeadsListCall) PageSize(pageSize int64) *LeadsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": A token
+// identifying a page of results that the server returns.
+// Typically, this is the value of
+// `ListLeadsResponse.next_page_token`
+// returned from the previous call to
+// ListLeads.
+func (c *LeadsListCall) PageToken(pageToken string) *LeadsListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *LeadsListCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *LeadsListCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *LeadsListCall) RequestMetadataLocale(requestMetadataLocale string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *LeadsListCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *LeadsListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *LeadsListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *LeadsListCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *LeadsListCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *LeadsListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *LeadsListCall) Fields(s ...googleapi.Field) *LeadsListCall {
+ 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 *LeadsListCall) IfNoneMatch(entityTag string) *LeadsListCall {
+ 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 *LeadsListCall) Context(ctx context.Context) *LeadsListCall {
+ 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 *LeadsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *LeadsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/leads")
+ 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 "partners.leads.list" call.
+// Exactly one of *ListLeadsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListLeadsResponse.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 *LeadsListCall) Do(opts ...googleapi.CallOption) (*ListLeadsResponse, 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 := &ListLeadsResponse{
+ 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 advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.",
+ // "flatPath": "v2/leads",
+ // "httpMethod": "GET",
+ // "id": "partners.leads.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "orderBy": {
+ // "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "Requested page size. Server may return fewer leads than requested.\nIf unspecified, server picks an appropriate default.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/leads",
+ // "response": {
+ // "$ref": "ListLeadsResponse"
+ // }
+ // }
+
+}
+
+// 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 *LeadsListCall) Pages(ctx context.Context, f func(*ListLeadsResponse) 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 "partners.offers.list":
+
+type OffersListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the Offers available for the current user
+func (r *OffersService) List() *OffersListCall {
+ c := &OffersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *OffersListCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *OffersListCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *OffersListCall) RequestMetadataLocale(requestMetadataLocale string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *OffersListCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *OffersListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *OffersListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *OffersListCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *OffersListCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *OffersListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *OffersListCall) Fields(s ...googleapi.Field) *OffersListCall {
+ 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 *OffersListCall) IfNoneMatch(entityTag string) *OffersListCall {
+ 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 *OffersListCall) Context(ctx context.Context) *OffersListCall {
+ 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 *OffersListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *OffersListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/offers")
+ 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 "partners.offers.list" call.
+// Exactly one of *ListOffersResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListOffersResponse.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 *OffersListCall) Do(opts ...googleapi.CallOption) (*ListOffersResponse, 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 := &ListOffersResponse{
+ 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 Offers available for the current user",
+ // "flatPath": "v2/offers",
+ // "httpMethod": "GET",
+ // "id": "partners.offers.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/offers",
+ // "response": {
+ // "$ref": "ListOffersResponse"
+ // }
+ // }
+
+}
+
+// method id "partners.offers.history.list":
+
+type OffersHistoryListCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: Lists the Historical Offers for the current user (or user's
+// entire company)
+func (r *OffersHistoryService) List() *OffersHistoryListCall {
+ c := &OffersHistoryListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// EntireCompany sets the optional parameter "entireCompany": if true,
+// show history for the entire company. Requires user to be admin.
+func (c *OffersHistoryListCall) EntireCompany(entireCompany bool) *OffersHistoryListCall {
+ c.urlParams_.Set("entireCompany", fmt.Sprint(entireCompany))
+ return c
+}
+
+// OrderBy sets the optional parameter "orderBy": Comma-separated list
+// of fields to order by, e.g.: "foo,bar,baz".
+// Use "foo desc" to sort descending.
+// List of valid field names is: name, offer_code, expiration_time,
+// status,
+// last_modified_time, sender_name, creation_time, country_code,
+// offer_type.
+func (c *OffersHistoryListCall) OrderBy(orderBy string) *OffersHistoryListCall {
+ c.urlParams_.Set("orderBy", orderBy)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": Maximum number of
+// rows to return per page.
+func (c *OffersHistoryListCall) PageSize(pageSize int64) *OffersHistoryListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": Token to retrieve
+// a specific page.
+func (c *OffersHistoryListCall) PageToken(pageToken string) *OffersHistoryListCall {
+ c.urlParams_.Set("pageToken", pageToken)
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *OffersHistoryListCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *OffersHistoryListCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *OffersHistoryListCall) RequestMetadataLocale(requestMetadataLocale string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *OffersHistoryListCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *OffersHistoryListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *OffersHistoryListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *OffersHistoryListCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *OffersHistoryListCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *OffersHistoryListCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *OffersHistoryListCall) Fields(s ...googleapi.Field) *OffersHistoryListCall {
+ 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 *OffersHistoryListCall) IfNoneMatch(entityTag string) *OffersHistoryListCall {
+ 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 *OffersHistoryListCall) Context(ctx context.Context) *OffersHistoryListCall {
+ 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 *OffersHistoryListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *OffersHistoryListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/offers/history")
+ 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 "partners.offers.history.list" call.
+// Exactly one of *ListOffersHistoryResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *ListOffersHistoryResponse.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 *OffersHistoryListCall) Do(opts ...googleapi.CallOption) (*ListOffersHistoryResponse, 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 := &ListOffersHistoryResponse{
+ 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 Historical Offers for the current user (or user's entire company)",
+ // "flatPath": "v2/offers/history",
+ // "httpMethod": "GET",
+ // "id": "partners.offers.history.list",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "entireCompany": {
+ // "description": "if true, show history for the entire company. Requires user to be admin.",
+ // "location": "query",
+ // "type": "boolean"
+ // },
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "Maximum number of rows to return per page.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "Token to retrieve a specific page.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/offers/history",
+ // "response": {
+ // "$ref": "ListOffersHistoryResponse"
+ // }
+ // }
+
+}
+
+// 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 *OffersHistoryListCall) Pages(ctx context.Context, f func(*ListOffersHistoryResponse) 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 "partners.userEvents.log":
type UserEventsLogCall struct {
@@ -2633,8 +5725,11 @@
return ret, nil
// {
// "description": "Logs a user event.",
+ // "flatPath": "v2/userEvents:log",
// "httpMethod": "POST",
// "id": "partners.userEvents.log",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v2/userEvents:log",
// "request": {
// "$ref": "LogUserEventRequest"
@@ -2686,8 +5781,10 @@
// RequestMetadataTrafficSourceTrafficSourceId sets the optional
// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *UserStatesListCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *UserStatesListCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
return c
@@ -2695,8 +5792,10 @@
// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
// "requestMetadata.trafficSource.trafficSubId": Second level identifier
-// to indicate where the traffic comes from. An identifier has multiple
-// letters created by a team which redirected the traffic to us.
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
func (c *UserStatesListCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *UserStatesListCall {
c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
return c
@@ -2811,8 +5910,10 @@
return ret, nil
// {
// "description": "Lists states for current user.",
+ // "flatPath": "v2/userStates",
// "httpMethod": "GET",
// "id": "partners.userStates.list",
+ // "parameterOrder": [],
// "parameters": {
// "requestMetadata.experimentIds": {
// "description": "Experiment IDs the current request belongs to.",
@@ -2831,12 +5932,12 @@
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSourceId": {
- // "description": "Identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic to us.",
+ // "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",
// "type": "string"
// },
// "requestMetadata.trafficSource.trafficSubId": {
- // "description": "Second level identifier to indicate where the traffic comes from. An identifier has multiple letters created by a team which redirected the traffic 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.",
// "location": "query",
// "type": "string"
// },
@@ -2858,3 +5959,1605 @@
// }
}
+
+// method id "partners.users.createCompanyRelation":
+
+type UsersCreateCompanyRelationCall struct {
+ s *Service
+ userId string
+ companyrelation *CompanyRelation
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// CreateCompanyRelation: Creates a user's company relation. Affiliates
+// the user to a company.
+func (r *UsersService) CreateCompanyRelation(userId string, companyrelation *CompanyRelation) *UsersCreateCompanyRelationCall {
+ c := &UsersCreateCompanyRelationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.userId = userId
+ c.companyrelation = companyrelation
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataLocale(requestMetadataLocale string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *UsersCreateCompanyRelationCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *UsersCreateCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *UsersCreateCompanyRelationCall) Fields(s ...googleapi.Field) *UsersCreateCompanyRelationCall {
+ 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 *UsersCreateCompanyRelationCall) Context(ctx context.Context) *UsersCreateCompanyRelationCall {
+ 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 *UsersCreateCompanyRelationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *UsersCreateCompanyRelationCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.companyrelation)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/users/{userId}/companyRelation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PUT", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "userId": c.userId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.users.createCompanyRelation" call.
+// Exactly one of *CompanyRelation or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *CompanyRelation.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 *UsersCreateCompanyRelationCall) Do(opts ...googleapi.CallOption) (*CompanyRelation, 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 := &CompanyRelation{
+ 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 user's company relation. Affiliates the user to a company.",
+ // "flatPath": "v2/users/{userId}/companyRelation",
+ // "httpMethod": "PUT",
+ // "id": "partners.users.createCompanyRelation",
+ // "parameterOrder": [
+ // "userId"
+ // ],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "userId": {
+ // "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/users/{userId}/companyRelation",
+ // "request": {
+ // "$ref": "CompanyRelation"
+ // },
+ // "response": {
+ // "$ref": "CompanyRelation"
+ // }
+ // }
+
+}
+
+// method id "partners.users.deleteCompanyRelation":
+
+type UsersDeleteCompanyRelationCall struct {
+ s *Service
+ userId string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// DeleteCompanyRelation: Deletes a user's company relation.
+// Unaffiliaites the user from a company.
+func (r *UsersService) DeleteCompanyRelation(userId string) *UsersDeleteCompanyRelationCall {
+ c := &UsersDeleteCompanyRelationCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.userId = userId
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataLocale(requestMetadataLocale string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *UsersDeleteCompanyRelationCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *UsersDeleteCompanyRelationCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *UsersDeleteCompanyRelationCall) Fields(s ...googleapi.Field) *UsersDeleteCompanyRelationCall {
+ 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 *UsersDeleteCompanyRelationCall) Context(ctx context.Context) *UsersDeleteCompanyRelationCall {
+ 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 *UsersDeleteCompanyRelationCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *UsersDeleteCompanyRelationCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/users/{userId}/companyRelation")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "userId": c.userId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.users.deleteCompanyRelation" 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 *UsersDeleteCompanyRelationCall) 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 a user's company relation. Unaffiliaites the user from a company.",
+ // "flatPath": "v2/users/{userId}/companyRelation",
+ // "httpMethod": "DELETE",
+ // "id": "partners.users.deleteCompanyRelation",
+ // "parameterOrder": [
+ // "userId"
+ // ],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "userId": {
+ // "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/users/{userId}/companyRelation",
+ // "response": {
+ // "$ref": "Empty"
+ // }
+ // }
+
+}
+
+// method id "partners.users.get":
+
+type UsersGetCall struct {
+ s *Service
+ userId string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get: Gets a user.
+func (r *UsersService) Get(userId string) *UsersGetCall {
+ c := &UsersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.userId = userId
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *UsersGetCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *UsersGetCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *UsersGetCall) RequestMetadataLocale(requestMetadataLocale string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *UsersGetCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersGetCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersGetCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *UsersGetCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *UsersGetCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *UsersGetCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ return c
+}
+
+// UserView sets the optional parameter "userView": Specifies what parts
+// of the user information to return.
+//
+// Possible values:
+// "BASIC"
+// "PROFILE"
+// "PUBLIC_PROFILE"
+func (c *UsersGetCall) UserView(userView string) *UsersGetCall {
+ c.urlParams_.Set("userView", userView)
+ 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 *UsersGetCall) Fields(s ...googleapi.Field) *UsersGetCall {
+ 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 *UsersGetCall) IfNoneMatch(entityTag string) *UsersGetCall {
+ 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 *UsersGetCall) Context(ctx context.Context) *UsersGetCall {
+ 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 *UsersGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *UsersGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/users/{userId}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "userId": c.userId,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.users.get" call.
+// Exactly one of *User or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *User.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 *UsersGetCall) Do(opts ...googleapi.CallOption) (*User, 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 := &User{
+ 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 user.",
+ // "flatPath": "v2/users/{userId}",
+ // "httpMethod": "GET",
+ // "id": "partners.users.get",
+ // "parameterOrder": [
+ // "userId"
+ // ],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "userId": {
+ // "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "userView": {
+ // "description": "Specifies what parts of the user information to return.",
+ // "enum": [
+ // "BASIC",
+ // "PROFILE",
+ // "PUBLIC_PROFILE"
+ // ],
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/users/{userId}",
+ // "response": {
+ // "$ref": "User"
+ // }
+ // }
+
+}
+
+// method id "partners.users.updateProfile":
+
+type UsersUpdateProfileCall struct {
+ s *Service
+ userprofile *UserProfile
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// UpdateProfile: Updates a user's profile. A user can only update their
+// own profile and
+// should only be called within the context of a logged in user.
+func (r *UsersService) UpdateProfile(userprofile *UserProfile) *UsersUpdateProfileCall {
+ c := &UsersUpdateProfileCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.userprofile = userprofile
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *UsersUpdateProfileCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *UsersUpdateProfileCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *UsersUpdateProfileCall) RequestMetadataLocale(requestMetadataLocale string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *UsersUpdateProfileCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersUpdateProfileCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *UsersUpdateProfileCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *UsersUpdateProfileCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *UsersUpdateProfileCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *UsersUpdateProfileCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *UsersUpdateProfileCall) Fields(s ...googleapi.Field) *UsersUpdateProfileCall {
+ 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 *UsersUpdateProfileCall) Context(ctx context.Context) *UsersUpdateProfileCall {
+ 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 *UsersUpdateProfileCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *UsersUpdateProfileCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.userprofile)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/users/profile")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.users.updateProfile" call.
+// Exactly one of *UserProfile or error will be non-nil. Any non-2xx
+// status code is an error. Response headers are in either
+// *UserProfile.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 *UsersUpdateProfileCall) Do(opts ...googleapi.CallOption) (*UserProfile, 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 := &UserProfile{
+ 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 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.",
+ // "flatPath": "v2/users/profile",
+ // "httpMethod": "PATCH",
+ // "id": "partners.users.updateProfile",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/users/profile",
+ // "request": {
+ // "$ref": "UserProfile"
+ // },
+ // "response": {
+ // "$ref": "UserProfile"
+ // }
+ // }
+
+}
+
+// method id "partners.getPartnersstatus":
+
+type V2GetPartnersstatusCall struct {
+ s *Service
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// GetPartnersstatus: Gets Partners Status of the logged in user's
+// agency.
+// Should only be called if the logged in user is the admin of the
+// agency.
+func (r *V2Service) GetPartnersstatus() *V2GetPartnersstatusCall {
+ c := &V2GetPartnersstatusCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *V2GetPartnersstatusCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *V2GetPartnersstatusCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *V2GetPartnersstatusCall) RequestMetadataLocale(requestMetadataLocale string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *V2GetPartnersstatusCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2GetPartnersstatusCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2GetPartnersstatusCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *V2GetPartnersstatusCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *V2GetPartnersstatusCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *V2GetPartnersstatusCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ 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 *V2GetPartnersstatusCall) Fields(s ...googleapi.Field) *V2GetPartnersstatusCall {
+ 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 *V2GetPartnersstatusCall) IfNoneMatch(entityTag string) *V2GetPartnersstatusCall {
+ 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 *V2GetPartnersstatusCall) Context(ctx context.Context) *V2GetPartnersstatusCall {
+ 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 *V2GetPartnersstatusCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *V2GetPartnersstatusCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v2/partnersstatus")
+ 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 "partners.getPartnersstatus" call.
+// Exactly one of *GetPartnersStatusResponse or error will be non-nil.
+// Any non-2xx status code is an error. Response headers are in either
+// *GetPartnersStatusResponse.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 *V2GetPartnersstatusCall) Do(opts ...googleapi.CallOption) (*GetPartnersStatusResponse, 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 := &GetPartnersStatusResponse{
+ 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 Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.",
+ // "flatPath": "v2/partnersstatus",
+ // "httpMethod": "GET",
+ // "id": "partners.getPartnersstatus",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/partnersstatus",
+ // "response": {
+ // "$ref": "GetPartnersStatusResponse"
+ // }
+ // }
+
+}
+
+// method id "partners.updateCompanies":
+
+type V2UpdateCompaniesCall struct {
+ s *Service
+ company *Company
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// UpdateCompanies: Update company.
+// Should only be called within the context of an authorized logged in
+// user.
+func (r *V2Service) UpdateCompanies(company *Company) *V2UpdateCompaniesCall {
+ c := &V2UpdateCompaniesCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.company = company
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *V2UpdateCompaniesCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *V2UpdateCompaniesCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *V2UpdateCompaniesCall) RequestMetadataLocale(requestMetadataLocale string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *V2UpdateCompaniesCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2UpdateCompaniesCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2UpdateCompaniesCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *V2UpdateCompaniesCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *V2UpdateCompaniesCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *V2UpdateCompaniesCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Standard field
+// mask for the set of fields to be updated.
+// Required with at least 1 value in FieldMask's paths.
+func (c *V2UpdateCompaniesCall) UpdateMask(updateMask string) *V2UpdateCompaniesCall {
+ 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 *V2UpdateCompaniesCall) Fields(s ...googleapi.Field) *V2UpdateCompaniesCall {
+ 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 *V2UpdateCompaniesCall) Context(ctx context.Context) *V2UpdateCompaniesCall {
+ 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 *V2UpdateCompaniesCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *V2UpdateCompaniesCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.company)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/companies")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.updateCompanies" call.
+// Exactly one of *Company or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Company.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 *V2UpdateCompaniesCall) Do(opts ...googleapi.CallOption) (*Company, 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 := &Company{
+ 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": "Update company.\nShould only be called within the context of an authorized logged in user.",
+ // "flatPath": "v2/companies",
+ // "httpMethod": "PATCH",
+ // "id": "partners.updateCompanies",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/companies",
+ // "request": {
+ // "$ref": "Company"
+ // },
+ // "response": {
+ // "$ref": "Company"
+ // }
+ // }
+
+}
+
+// method id "partners.updateLeads":
+
+type V2UpdateLeadsCall struct {
+ s *Service
+ lead *Lead
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// UpdateLeads: Updates the specified lead.
+func (r *V2Service) UpdateLeads(lead *Lead) *V2UpdateLeadsCall {
+ c := &V2UpdateLeadsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.lead = lead
+ return c
+}
+
+// RequestMetadataExperimentIds sets the optional parameter
+// "requestMetadata.experimentIds": Experiment IDs the current request
+// belongs to.
+func (c *V2UpdateLeadsCall) RequestMetadataExperimentIds(requestMetadataExperimentIds ...string) *V2UpdateLeadsCall {
+ c.urlParams_.SetMulti("requestMetadata.experimentIds", append([]string{}, requestMetadataExperimentIds...))
+ return c
+}
+
+// RequestMetadataLocale sets the optional parameter
+// "requestMetadata.locale": Locale to use for the current request.
+func (c *V2UpdateLeadsCall) RequestMetadataLocale(requestMetadataLocale string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.locale", requestMetadataLocale)
+ return c
+}
+
+// RequestMetadataPartnersSessionId sets the optional parameter
+// "requestMetadata.partnersSessionId": Google Partners session ID.
+func (c *V2UpdateLeadsCall) RequestMetadataPartnersSessionId(requestMetadataPartnersSessionId string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.partnersSessionId", requestMetadataPartnersSessionId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSourceId sets the optional
+// parameter "requestMetadata.trafficSource.trafficSourceId": Identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2UpdateLeadsCall) RequestMetadataTrafficSourceTrafficSourceId(requestMetadataTrafficSourceTrafficSourceId string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSourceId", requestMetadataTrafficSourceTrafficSourceId)
+ return c
+}
+
+// RequestMetadataTrafficSourceTrafficSubId sets the optional parameter
+// "requestMetadata.trafficSource.trafficSubId": Second level identifier
+// to indicate where the traffic comes from.
+// An identifier has multiple letters created by a team which redirected
+// the
+// traffic to us.
+func (c *V2UpdateLeadsCall) RequestMetadataTrafficSourceTrafficSubId(requestMetadataTrafficSourceTrafficSubId string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.trafficSource.trafficSubId", requestMetadataTrafficSourceTrafficSubId)
+ return c
+}
+
+// RequestMetadataUserOverridesIpAddress sets the optional parameter
+// "requestMetadata.userOverrides.ipAddress": IP address to use instead
+// of the user's geo-located IP address.
+func (c *V2UpdateLeadsCall) RequestMetadataUserOverridesIpAddress(requestMetadataUserOverridesIpAddress string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.ipAddress", requestMetadataUserOverridesIpAddress)
+ return c
+}
+
+// RequestMetadataUserOverridesUserId sets the optional parameter
+// "requestMetadata.userOverrides.userId": Logged-in user ID to
+// impersonate instead of the user's ID.
+func (c *V2UpdateLeadsCall) RequestMetadataUserOverridesUserId(requestMetadataUserOverridesUserId string) *V2UpdateLeadsCall {
+ c.urlParams_.Set("requestMetadata.userOverrides.userId", requestMetadataUserOverridesUserId)
+ return c
+}
+
+// UpdateMask sets the optional parameter "updateMask": Standard field
+// mask for the set of fields to be updated.
+// Required with at least 1 value in FieldMask's paths.
+// Only `state` and `adwords_customer_id` are currently supported.
+func (c *V2UpdateLeadsCall) UpdateMask(updateMask string) *V2UpdateLeadsCall {
+ 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 *V2UpdateLeadsCall) Fields(s ...googleapi.Field) *V2UpdateLeadsCall {
+ 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 *V2UpdateLeadsCall) Context(ctx context.Context) *V2UpdateLeadsCall {
+ 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 *V2UpdateLeadsCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *V2UpdateLeadsCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ body, err := googleapi.WithoutDataWrapper.JSONReader(c.lead)
+ if err != nil {
+ return nil, err
+ }
+ reqHeaders.Set("Content-Type", "application/json")
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v2/leads")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("PATCH", urls, body)
+ req.Header = reqHeaders
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "partners.updateLeads" call.
+// Exactly one of *Lead or error will be non-nil. Any non-2xx status
+// code is an error. Response headers are in either
+// *Lead.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 *V2UpdateLeadsCall) Do(opts ...googleapi.CallOption) (*Lead, 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 := &Lead{
+ 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 the specified lead.",
+ // "flatPath": "v2/leads",
+ // "httpMethod": "PATCH",
+ // "id": "partners.updateLeads",
+ // "parameterOrder": [],
+ // "parameters": {
+ // "requestMetadata.experimentIds": {
+ // "description": "Experiment IDs the current request belongs to.",
+ // "location": "query",
+ // "repeated": true,
+ // "type": "string"
+ // },
+ // "requestMetadata.locale": {
+ // "description": "Locale to use for the current request.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.partnersSessionId": {
+ // "description": "Google Partners session ID.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "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.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.ipAddress": {
+ // "description": "IP address to use instead of the user's geo-located IP address.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "requestMetadata.userOverrides.userId": {
+ // "description": "Logged-in user ID to impersonate instead of the user's ID.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "updateMask": {
+ // "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.",
+ // "format": "google-fieldmask",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v2/leads",
+ // "request": {
+ // "$ref": "Lead"
+ // },
+ // "response": {
+ // "$ref": "Lead"
+ // }
+ // }
+
+}
diff --git a/people/v1/people-api.json b/people/v1/people-api.json
index c48dec4..a05b30a 100644
--- a/people/v1/people-api.json
+++ b/people/v1/people-api.json
@@ -1,82 +1,38 @@
{
+ "batchPath": "batch",
+ "id": "people:v1",
+ "revision": "20170309",
+ "documentationLink": "https://developers.google.com/people/",
+ "title": "Google People API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
+ "version_module": "True",
"resources": {
"people": {
- "resources": {
- "connections": {
- "methods": {
- "list": {
- "response": {
- "$ref": "ListConnectionsResponse"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "requestSyncToken": {
- "location": "query",
- "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
- "type": "boolean"
- },
- "resourceName": {
- "pattern": "^people/[^/]+$",
- "location": "path",
- "description": "The resource name to return connections for. Only `people/me` is valid.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The token of the page to be returned.",
- "type": "string"
- },
- "pageSize": {
- "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 500, inclusive. Defaults to 100.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "requestMask.includeField": {
- "location": "query",
- "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`person.photos`.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "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"
- },
- "sortOrder": {
- "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.",
- "type": "string",
- "location": "query",
- "enum": [
- "LAST_MODIFIED_ASCENDING",
- "FIRST_NAME_ASCENDING",
- "LAST_NAME_ASCENDING"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/contacts",
- "https://www.googleapis.com/auth/contacts.readonly"
- ],
- "flatPath": "v1/people/{peopleId}/connections",
- "path": "v1/{+resourceName}/connections",
- "id": "people.people.connections.list",
- "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles."
- }
- }
- }
- },
"methods": {
"getBatchGet": {
+ "path": "v1/people:batchGet",
+ "id": "people.people.getBatchGet",
+ "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.",
"response": {
"$ref": "GetPeopleResponse"
},
"parameterOrder": [],
"httpMethod": "GET",
+ "parameters": {
+ "requestMask.includeField": {
+ "location": "query",
+ "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "resourceNames": {
+ "location": "query",
+ "description": "The resource name, such as one returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list),\nof one of the people to provide information about. You can include this\nparameter up to 50 times in one request.",
+ "type": "string",
+ "repeated": true
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/contacts",
"https://www.googleapis.com/auth/contacts.readonly",
@@ -88,24 +44,7 @@
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
],
- "parameters": {
- "requestMask.includeField": {
- "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`person.photos`.",
- "format": "google-fieldmask",
- "type": "string",
- "location": "query"
- },
- "resourceNames": {
- "location": "query",
- "description": "The resource name, such as one returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list),\nof one of the people to provide information about. You can include this\nparameter up to 50 times in one request.",
- "type": "string",
- "repeated": true
- }
- },
- "flatPath": "v1/people:batchGet",
- "path": "v1/people:batchGet",
- "id": "people.people.getBatchGet",
- "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser."
+ "flatPath": "v1/people:batchGet"
},
"get": {
"httpMethod": "GET",
@@ -146,65 +85,122 @@
"path": "v1/{+resourceName}",
"description": "Provides information about a person resource for a resource name. Use\n`people/me` to indicate the authenticated user."
}
+ },
+ "resources": {
+ "connections": {
+ "methods": {
+ "list": {
+ "flatPath": "v1/people/{peopleId}/connections",
+ "path": "v1/{+resourceName}/connections",
+ "id": "people.people.connections.list",
+ "description": "Provides a list of the authenticated user's contacts merged with any\nlinked profiles.",
+ "response": {
+ "$ref": "ListConnectionsResponse"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/contacts",
+ "https://www.googleapis.com/auth/contacts.readonly"
+ ],
+ "parameters": {
+ "requestSyncToken": {
+ "location": "query",
+ "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.",
+ "type": "boolean"
+ },
+ "resourceName": {
+ "location": "path",
+ "description": "The resource name to return connections for. Only `people/me` is valid.",
+ "required": true,
+ "type": "string",
+ "pattern": "^people/[^/]+$"
+ },
+ "pageToken": {
+ "description": "The token of the page to be returned.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 500, inclusive. Defaults to 100.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "requestMask.includeField": {
+ "location": "query",
+ "description": "Comma-separated list of fields to be included in the response. Omitting\nthis field will include all fields except for connections.list requests,\nwhich have a default mask that includes common fields like metadata, name,\nphoto, and profile url.\nEach path should start with `person.`: for example, `person.names` or\n`person.photos`.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "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"
+ },
+ "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"
+ ]
+ }
+ }
+ }
+ }
+ }
}
}
},
"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": {
+ "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": {
"description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "upload_protocol": {
+ "oauth_token": {
"location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "description": "OAuth 2.0 token for the current user.",
"type": "string"
},
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true"
},
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"type": "string",
"location": "query"
},
- "$.xgafv": {
- "description": "V1 error format.",
+ "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"
@@ -213,12 +209,9 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
"description": "Data format for response.",
@@ -235,76 +228,662 @@
"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"
}
},
"schemas": {
+ "ProfileMetadata": {
+ "description": "The read-only metadata about a profile.",
+ "type": "object",
+ "properties": {
+ "objectType": {
+ "enum": [
+ "OBJECT_TYPE_UNSPECIFIED",
+ "PERSON",
+ "PAGE"
+ ],
+ "description": "The profile object type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "Person.",
+ "[Google+ Page.](http://www.google.com/+/brands/)"
+ ]
+ }
+ },
+ "id": "ProfileMetadata"
+ },
+ "Url": {
+ "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."
+ },
+ "type": {
+ "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
+ "type": "string"
+ }
+ },
+ "id": "Url",
+ "description": "A person's associated URLs.",
+ "type": "object"
+ },
+ "Gender": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "id": "Gender",
+ "description": "A person's gender.",
+ "type": "object"
+ },
+ "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": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the cover photo."
+ },
+ "default": {
+ "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
+ "type": "boolean"
+ },
+ "url": {
+ "description": "The URL of the cover photo.",
+ "type": "string"
+ }
+ },
+ "id": "CoverPhoto"
+ },
+ "Interest": {
+ "description": "One of the person's interests.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The interest; for example, `stargazing`.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the interest."
+ }
+ },
+ "id": "Interest"
+ },
+ "ImClient": {
+ "description": "A person's instant messaging client.",
+ "type": "object",
+ "properties": {
+ "formattedProtocol": {
+ "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "description": "Metadata about the IM client.",
+ "$ref": "FieldMetadata"
+ },
+ "type": {
+ "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "protocol": {
+ "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
+ "type": "string"
+ },
+ "username": {
+ "description": "The user name used in the IM client.",
+ "type": "string"
+ }
+ },
+ "id": "ImClient"
+ },
+ "Nickname": {
+ "description": "A person's nickname.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the nickname."
+ },
+ "type": {
+ "enumDescriptions": [
+ "Generic nickname.",
+ "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
+ "Initials.",
+ "Google+ profile nickname.",
+ "A professional affiliation or other name; for example, `Dr. Smith.`"
+ ],
+ "enum": [
+ "DEFAULT",
+ "MAIDEN_NAME",
+ "INITIALS",
+ "GPLUS",
+ "OTHER_NAME"
+ ],
+ "description": "The type of the nickname.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The nickname.",
+ "type": "string"
+ }
+ },
+ "id": "Nickname"
+ },
+ "EmailAddress": {
+ "description": "A person's email address.",
+ "type": "object",
+ "properties": {
+ "formattedType": {
+ "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The display name of the email.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the email address."
+ },
+ "type": {
+ "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
+ "type": "string"
+ },
+ "value": {
+ "description": "The email address.",
+ "type": "string"
+ }
+ },
+ "id": "EmailAddress"
+ },
+ "Skill": {
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the skill."
+ },
+ "value": {
+ "description": "The skill; for example, `underwater basket weaving`.",
+ "type": "string"
+ }
+ },
+ "id": "Skill",
+ "description": "A skill that the person has.",
+ "type": "object"
+ },
+ "DomainMembership": {
+ "description": "A Google Apps Domain membership.",
+ "type": "object",
+ "properties": {
+ "inViewerDomain": {
+ "description": "True if the person is in the viewer's Google Apps domain.",
+ "type": "boolean"
+ }
+ },
+ "id": "DomainMembership"
+ },
+ "Membership": {
+ "description": "A person's read-only membership in a group.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the membership.",
+ "$ref": "FieldMetadata"
+ },
+ "contactGroupMembership": {
+ "$ref": "ContactGroupMembership",
+ "description": "The contact group membership."
+ },
+ "domainMembership": {
+ "description": "The domain membership.",
+ "$ref": "DomainMembership"
+ }
+ },
+ "id": "Membership"
+ },
+ "RelationshipStatus": {
+ "description": "A person's read-only relationship status.",
+ "type": "object",
+ "properties": {
+ "formattedValue": {
+ "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship status."
+ },
+ "value": {
+ "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
+ "type": "string"
+ }
+ },
+ "id": "RelationshipStatus"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
+ "type": "object",
+ "properties": {
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Date"
+ },
+ "Tagline": {
+ "properties": {
+ "metadata": {
+ "description": "Metadata about the tagline.",
+ "$ref": "FieldMetadata"
+ },
+ "value": {
+ "description": "The tagline.",
+ "type": "string"
+ }
+ },
+ "id": "Tagline",
+ "description": "A read-only brief one-line description of the person.",
+ "type": "object"
+ },
+ "Name": {
+ "description": "A person's name. If the name is a mononym, the family name is empty.",
+ "type": "object",
+ "properties": {
+ "honorificPrefix": {
+ "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
+ "type": "string"
+ },
+ "phoneticHonorificSuffix": {
+ "description": "The honorific suffixes spelled as they sound.",
+ "type": "string"
+ },
+ "middleName": {
+ "description": "The middle name(s).",
+ "type": "string"
+ },
+ "givenName": {
+ "description": "The given name.",
+ "type": "string"
+ },
+ "phoneticHonorificPrefix": {
+ "description": "The honorific prefixes spelled as they sound.",
+ "type": "string"
+ },
+ "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": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the name."
+ },
+ "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\u003ccode\u003eAccept-Language\u003c/code\u003e HTTP header.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the \u003ccode\u003eAccept-Language\u003c/code\u003e HTTP header.",
+ "type": "string"
+ },
+ "honorificSuffix": {
+ "description": "The honorific suffixes, such as `Jr.`",
+ "type": "string"
+ }
+ },
+ "id": "Name"
+ },
+ "BraggingRights": {
+ "description": "A person's bragging rights.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The bragging rights; for example, `climbed mount everest`.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the bragging rights."
+ }
+ },
+ "id": "BraggingRights"
+ },
+ "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"
+ },
+ "Organization": {
+ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
+ "type": "object",
+ "properties": {
+ "current": {
+ "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.",
+ "type": "boolean"
+ },
+ "startDate": {
+ "description": "The start date when the person joined the organization.",
+ "$ref": "Date"
+ },
+ "formattedType": {
+ "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
+ "type": "string"
+ },
+ "domain": {
+ "description": "The domain name associated with the organization; for example, `google.com`.",
+ "type": "string"
+ },
+ "department": {
+ "description": "The person's department at the organization.",
+ "type": "string"
+ },
+ "phoneticName": {
+ "description": "The phonetic name of the organization.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
+ "type": "string"
+ },
+ "jobDescription": {
+ "description": "The person's job description at the organization.",
+ "type": "string"
+ },
+ "endDate": {
+ "description": "The end date when the person left the organization.",
+ "$ref": "Date"
+ },
+ "symbol": {
+ "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the organization.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the organization."
+ },
+ "title": {
+ "description": "The person's job title at the organization.",
+ "type": "string"
+ },
+ "location": {
+ "description": "The location of the organization office the person works at.",
+ "type": "string"
+ }
+ },
+ "id": "Organization"
+ },
+ "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"
+ },
+ "AgeRangeType": {
+ "description": "A person's age range.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the age range."
+ },
+ "ageRange": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "Younger than eighteen.",
+ "Between eighteen and twenty.",
+ "Twenty-one and older."
+ ],
+ "enum": [
+ "AGE_RANGE_UNSPECIFIED",
+ "LESS_THAN_EIGHTEEN",
+ "EIGHTEEN_TO_TWENTY",
+ "TWENTY_ONE_OR_OLDER"
+ ],
+ "description": "The age range.",
+ "type": "string"
+ }
+ },
+ "id": "AgeRangeType"
+ },
+ "FieldMetadata": {
+ "description": "Metadata about a field.",
+ "type": "object",
+ "properties": {
+ "verified": {
+ "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
+ "type": "boolean"
+ },
+ "primary": {
+ "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
+ "type": "boolean"
+ },
+ "source": {
+ "$ref": "Source",
+ "description": "The source of the field."
+ }
+ },
+ "id": "FieldMetadata"
+ },
+ "PersonResponse": {
+ "description": "The response for a single person",
+ "type": "object",
+ "properties": {
+ "httpStatusCode": {
+ "description": "[HTTP 1.1 status code](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"
+ },
+ "person": {
+ "$ref": "Person",
+ "description": "The person."
+ }
+ },
+ "id": "PersonResponse"
+ },
+ "RelationshipInterest": {
+ "description": "A person's read-only relationship interest .",
+ "type": "object",
+ "properties": {
+ "formattedValue": {
+ "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relationship interest."
+ },
+ "value": {
+ "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
+ "type": "string"
+ }
+ },
+ "id": "RelationshipInterest"
+ },
+ "Source": {
+ "description": "The source of a field.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "The source type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified.",
+ "[Google Account](https://accounts.google.com).",
+ "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cid\u003e where \u003cid\u003e is the source\nid.",
+ "[Google Apps domain profile](https://admin.google.com).",
+ "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cid\u003e where \u003cid\u003e is the source\nid."
+ ],
+ "enum": [
+ "SOURCE_TYPE_UNSPECIFIED",
+ "ACCOUNT",
+ "PROFILE",
+ "DOMAIN_PROFILE",
+ "CONTACT"
+ ]
+ },
+ "etag": {
+ "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique identifier within the source type generated by the server.",
+ "type": "string"
+ },
+ "profileMetadata": {
+ "$ref": "ProfileMetadata",
+ "description": "Metadata about a source of type PROFILE."
+ }
+ },
+ "id": "Source"
+ },
+ "Relation": {
+ "description": "A person's relation to another person.",
+ "type": "object",
+ "properties": {
+ "person": {
+ "description": "The name of the other person this relation refers to.",
+ "type": "string"
+ },
+ "formattedType": {
+ "description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
+ "type": "string"
+ },
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the relation."
+ },
+ "type": {
+ "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
+ "type": "string"
+ }
+ },
+ "id": "Relation"
+ },
+ "Occupation": {
+ "description": "A person's occupation.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the occupation."
+ },
+ "value": {
+ "description": "The occupation; for example, `carpenter`.",
+ "type": "string"
+ }
+ },
+ "id": "Occupation"
+ },
"Person": {
"description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data. Fields other than IDs,\nmetadata, and group memberships are user-edited.\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.\nNEXT_ID: 31",
"type": "object",
"properties": {
- "events": {
- "description": "The person's events.",
- "type": "array",
- "items": {
- "$ref": "Event"
- }
- },
- "memberships": {
- "description": "The person's group memberships.",
- "type": "array",
- "items": {
- "$ref": "Membership"
- }
- },
- "phoneNumbers": {
- "description": "The person's phone numbers.",
- "type": "array",
- "items": {
- "$ref": "PhoneNumber"
- }
- },
- "coverPhotos": {
- "description": "The person's cover photos.",
- "type": "array",
- "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"
- }
- },
- "locales": {
- "description": "The person's locale preferences.",
- "type": "array",
- "items": {
- "$ref": "Locale"
- }
- },
- "relationshipInterests": {
- "description": "The kind of relationship the person is looking for.",
- "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",
@@ -312,13 +891,6 @@
"$ref": "Nickname"
}
},
- "names": {
- "description": "The person's names.",
- "type": "array",
- "items": {
- "$ref": "Name"
- }
- },
"relations": {
"description": "The person's relations.",
"type": "array",
@@ -326,6 +898,13 @@
"$ref": "Relation"
}
},
+ "names": {
+ "description": "The person's names.",
+ "type": "array",
+ "items": {
+ "$ref": "Name"
+ }
+ },
"occupations": {
"description": "The person's occupations.",
"type": "array",
@@ -451,12 +1030,74 @@
"items": {
"$ref": "Address"
}
+ },
+ "events": {
+ "description": "The person's events.",
+ "type": "array",
+ "items": {
+ "$ref": "Event"
+ }
+ },
+ "memberships": {
+ "description": "The person's group memberships.",
+ "type": "array",
+ "items": {
+ "$ref": "Membership"
+ }
+ },
+ "phoneNumbers": {
+ "description": "The person's phone numbers.",
+ "type": "array",
+ "items": {
+ "$ref": "PhoneNumber"
+ }
+ },
+ "coverPhotos": {
+ "description": "The person's cover photos.",
+ "type": "array",
+ "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"
+ }
+ },
+ "locales": {
+ "description": "The person's locale preferences.",
+ "type": "array",
+ "items": {
+ "$ref": "Locale"
+ }
+ },
+ "relationshipInterests": {
+ "description": "The kind of relationship the person is looking for.",
+ "type": "array",
+ "items": {
+ "$ref": "RelationshipInterest"
+ }
+ },
+ "urls": {
+ "description": "The person's associated URLs.",
+ "type": "array",
+ "items": {
+ "$ref": "Url"
+ }
}
},
"id": "Person"
},
"GetPeopleResponse": {
- "type": "object",
"properties": {
"responses": {
"description": "The response for each requested resource name.",
@@ -466,26 +1107,25 @@
}
}
},
- "id": "GetPeopleResponse"
+ "id": "GetPeopleResponse",
+ "type": "object"
},
"Photo": {
+ "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
+ "type": "object",
"properties": {
"url": {
"description": "The URL of the photo.",
"type": "string"
},
"metadata": {
- "description": "Metadata about the photo.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the photo."
}
},
- "id": "Photo",
- "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.",
- "type": "object"
+ "id": "Photo"
},
"PhoneNumber": {
- "description": "A person's phone number.",
- "type": "object",
"properties": {
"metadata": {
"$ref": "FieldMetadata",
@@ -508,7 +1148,9 @@
"type": "string"
}
},
- "id": "PhoneNumber"
+ "id": "PhoneNumber",
+ "description": "A person's phone number.",
+ "type": "object"
},
"ListConnectionsResponse": {
"type": "object",
@@ -535,47 +1177,44 @@
"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": {
- "date": {
- "description": "The date of the birthday.",
- "$ref": "Date"
- },
"metadata": {
- "description": "Metadata about the birthday.",
- "$ref": "FieldMetadata"
+ "$ref": "FieldMetadata",
+ "description": "Metadata about the birthday."
},
"text": {
"description": "A free-form string representing the user's birthday.",
"type": "string"
+ },
+ "date": {
+ "$ref": "Date",
+ "description": "The date of the birthday."
}
},
"id": "Birthday"
},
- "Address": {
+ "Residence": {
"properties": {
- "poBox": {
- "description": "The P.O. box of the address.",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code of the address.",
- "type": "string"
- },
- "region": {
- "description": "The region of the address; for example, the state or province.",
- "type": "string"
- },
- "streetAddress": {
- "description": "The street address.",
- "type": "string"
- },
"metadata": {
"$ref": "FieldMetadata",
- "description": "Metadata about the address."
+ "description": "Metadata about the residence."
},
- "countryCode": {
- "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
+ "current": {
+ "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
+ "type": "boolean"
+ },
+ "value": {
+ "description": "The address of the residence.",
"type": "string"
- },
+ }
+ },
+ "id": "Residence",
+ "description": "A person's past or current residence.",
+ "type": "object"
+ },
+ "Address": {
+ "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
+ "type": "object",
+ "properties": {
"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"
@@ -599,46 +1238,53 @@
"extendedAddress": {
"description": "The extended address of the address; for example, the apartment number.",
"type": "string"
- }
- },
- "id": "Address",
- "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.",
- "type": "object"
- },
- "Residence": {
- "description": "A person's past or current residence.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The address of the residence.",
+ },
+ "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 residence."
+ "description": "Metadata about the address."
},
- "current": {
- "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.",
- "type": "boolean"
+ "countryCode": {
+ "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.",
+ "type": "string"
}
},
- "id": "Residence"
+ "id": "Address"
},
"ContactGroupMembership": {
- "description": "A Google contact group membership.",
- "type": "object",
"properties": {
"contactGroupId": {
"description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.",
"type": "string"
}
},
- "id": "ContactGroupMembership"
+ "id": "ContactGroupMembership",
+ "description": "A Google contact group membership.",
+ "type": "object"
},
"Event": {
"description": "An event related to the person.",
"type": "object",
"properties": {
+ "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."
@@ -648,12 +1294,8 @@
"type": "string"
},
"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"
+ "$ref": "Date",
+ "description": "The date of the event."
}
},
"id": "Event"
@@ -662,6 +1304,20 @@
"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 read person.metadata.sources.profile_metadata instead).\nThe type of the person object.",
+ "type": "string"
+ },
"linkedPeopleResourceNames": {
"description": "Resource names of people linked to this resource.",
"type": "array",
@@ -686,695 +1342,47 @@
"deleted": {
"description": "True if the person resource has been deleted. Populated only for\n[`connections.list`](/people/api/rest/v1/people.connections/list) requests\nthat include a sync token.",
"type": "boolean"
- },
- "objectType": {
- "description": "DEPRECATED(Please read person.metadata.sources.profile_metadata instead).\nThe type of the person object.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ]
}
},
"id": "PersonMetadata"
- },
- "ProfileMetadata": {
- "description": "The read-only metadata about a profile.",
- "type": "object",
- "properties": {
- "objectType": {
- "enumDescriptions": [
- "Unspecified.",
- "Person.",
- "[Google+ Page.](http://www.google.com/+/brands/)"
- ],
- "enum": [
- "OBJECT_TYPE_UNSPECIFIED",
- "PERSON",
- "PAGE"
- ],
- "description": "The profile object type.",
- "type": "string"
- }
- },
- "id": "ProfileMetadata"
- },
- "Gender": {
- "description": "A person's gender.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the gender.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`",
- "type": "string"
- },
- "formattedValue": {
- "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "Gender"
- },
- "Url": {
- "description": "A person's associated URLs.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the URL.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the URL. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `blog`\n* `profile`\n* `homePage`\n* `ftp`\n* `reservations`\n* `appInstallPage`: website for a Google+ application.\n* `other`",
- "type": "string"
- },
- "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"
- }
- },
- "id": "Url"
- },
- "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": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the cover photo."
- },
- "default": {
- "description": "True if the cover photo is the default cover photo;\nfalse if the cover photo is a user-provided cover photo.",
- "type": "boolean"
- },
- "url": {
- "description": "The URL of the cover photo.",
- "type": "string"
- }
- },
- "id": "CoverPhoto"
- },
- "Interest": {
- "description": "One of the person's interests.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the interest."
- },
- "value": {
- "description": "The interest; for example, `stargazing`.",
- "type": "string"
- }
- },
- "id": "Interest"
- },
- "ImClient": {
- "description": "A person's instant messaging client.",
- "type": "object",
- "properties": {
- "protocol": {
- "description": "The protocol of the IM client. The protocol can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `aim`\n* `msn`\n* `yahoo`\n* `skype`\n* `qq`\n* `googleTalk`\n* `icq`\n* `jabber`\n* `netMeeting`",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the IM client.",
- "$ref": "FieldMetadata"
- },
- "type": {
- "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
- "type": "string"
- },
- "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"
- },
- "formattedType": {
- "description": "The read-only type of the IM client translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- }
- },
- "id": "ImClient"
- },
- "Nickname": {
- "description": "A person's nickname.",
- "type": "object",
- "properties": {
- "metadata": {
- "$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": [
- "Generic nickname.",
- "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.",
- "Initials.",
- "Google+ profile nickname.",
- "A professional affiliation or other name; for example, `Dr. Smith.`"
- ]
- },
- "value": {
- "description": "The nickname.",
- "type": "string"
- }
- },
- "id": "Nickname"
- },
- "EmailAddress": {
- "description": "A person's email address.",
- "type": "object",
- "properties": {
- "formattedType": {
- "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "displayName": {
- "description": "The display name of the email.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the email address."
- },
- "type": {
- "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`",
- "type": "string"
- },
- "value": {
- "description": "The email address.",
- "type": "string"
- }
- },
- "id": "EmailAddress"
- },
- "Skill": {
- "description": "A skill that the person has.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the skill."
- },
- "value": {
- "description": "The skill; for example, `underwater basket weaving`.",
- "type": "string"
- }
- },
- "id": "Skill"
- },
- "DomainMembership": {
- "description": "A Google Apps Domain membership.",
- "type": "object",
- "properties": {
- "inViewerDomain": {
- "description": "True if the person is in the viewer's Google Apps domain.",
- "type": "boolean"
- }
- },
- "id": "DomainMembership"
- },
- "Membership": {
- "description": "A person's read-only membership in a group.",
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the membership."
- },
- "contactGroupMembership": {
- "description": "The contact group membership.",
- "$ref": "ContactGroupMembership"
- },
- "domainMembership": {
- "$ref": "DomainMembership",
- "description": "The domain membership."
- }
- },
- "id": "Membership"
- },
- "RelationshipStatus": {
- "properties": {
- "formattedValue": {
- "description": "The read-only value of the relationship status translated and formatted in\nthe viewer's account locale or the `Accept-Language` HTTP header locale.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship status."
- },
- "value": {
- "description": "The relationship status. The value can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `single`\n* `inARelationship`\n* `engaged`\n* `married`\n* `itsComplicated`\n* `openRelationship`\n* `widowed`\n* `inDomesticPartnership`\n* `inCivilUnion`",
- "type": "string"
- }
- },
- "id": "RelationshipStatus",
- "description": "A person's read-only relationship status.",
- "type": "object"
- },
- "Tagline": {
- "description": "A read-only brief one-line description of the person.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the tagline.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The tagline.",
- "type": "string"
- }
- },
- "id": "Tagline"
- },
- "Date": {
- "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.",
- "type": "object",
- "properties": {
- "year": {
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "Date"
- },
- "Name": {
- "description": "A person's name. If the name is a mononym, the family name is empty.",
- "type": "object",
- "properties": {
- "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\u003ccode\u003eAccept-Language\u003c/code\u003e HTTP header.",
- "type": "string"
- },
- "displayName": {
- "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the \u003ccode\u003eAccept-Language\u003c/code\u003e HTTP header.",
- "type": "string"
- },
- "honorificSuffix": {
- "description": "The honorific suffixes, such as `Jr.`",
- "type": "string"
- },
- "honorificPrefix": {
- "description": "The honorific prefixes, such as `Mrs.` or `Dr.`",
- "type": "string"
- },
- "phoneticHonorificSuffix": {
- "description": "The honorific suffixes spelled as they sound.",
- "type": "string"
- },
- "givenName": {
- "description": "The given name.",
- "type": "string"
- },
- "middleName": {
- "description": "The middle name(s).",
- "type": "string"
- },
- "phoneticHonorificPrefix": {
- "description": "The honorific prefixes spelled as they sound.",
- "type": "string"
- },
- "phoneticGivenName": {
- "description": "The given name spelled as it sounds.",
- "type": "string"
- }
- },
- "id": "Name"
- },
- "BraggingRights": {
- "properties": {
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the bragging rights."
- },
- "value": {
- "description": "The bragging rights; for example, `climbed mount everest`.",
- "type": "string"
- }
- },
- "id": "BraggingRights",
- "description": "A person's bragging rights.",
- "type": "object"
- },
- "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"
- },
- "Organization": {
- "description": "A person's past or current organization. Overlapping date ranges are\npermitted.",
- "type": "object",
- "properties": {
- "domain": {
- "description": "The domain name associated with the organization; for example, `google.com`.",
- "type": "string"
- },
- "department": {
- "description": "The person's department at the organization.",
- "type": "string"
- },
- "phoneticName": {
- "description": "The phonetic name of the organization.",
- "type": "string"
- },
- "type": {
- "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`",
- "type": "string"
- },
- "jobDescription": {
- "description": "The person's job description at the organization.",
- "type": "string"
- },
- "endDate": {
- "description": "The end date when the person left the organization.",
- "$ref": "Date"
- },
- "symbol": {
- "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.",
- "type": "string"
- },
- "name": {
- "description": "The name of the organization.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the organization."
- },
- "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."
- }
- },
- "id": "Organization"
- },
- "Biography": {
- "description": "A person's short biography.",
- "type": "object",
- "properties": {
- "contentType": {
- "enum": [
- "CONTENT_TYPE_UNSPECIFIED",
- "TEXT_PLAIN",
- "TEXT_HTML"
- ],
- "description": "The content type of the biography.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified.",
- "Plain text.",
- "HTML text."
- ]
- },
- "metadata": {
- "description": "Metadata about the biography.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The short biography.",
- "type": "string"
- }
- },
- "id": "Biography"
- },
- "AgeRangeType": {
- "properties": {
- "ageRange": {
- "enumDescriptions": [
- "Unspecified.",
- "Younger than eighteen.",
- "Between eighteen and twenty.",
- "Twenty-one and older."
- ],
- "enum": [
- "AGE_RANGE_UNSPECIFIED",
- "LESS_THAN_EIGHTEEN",
- "EIGHTEEN_TO_TWENTY",
- "TWENTY_ONE_OR_OLDER"
- ],
- "description": "The age range.",
- "type": "string"
- },
- "metadata": {
- "description": "Metadata about the age range.",
- "$ref": "FieldMetadata"
- }
- },
- "id": "AgeRangeType",
- "description": "A person's age range.",
- "type": "object"
- },
- "FieldMetadata": {
- "description": "Metadata about a field.",
- "type": "object",
- "properties": {
- "verified": {
- "description": "True if the field is verified; false if the field is unverified. A\nverified field is typically a name, email address, phone number, or\nwebsite that has been confirmed to be owned by the person.",
- "type": "boolean"
- },
- "primary": {
- "description": "True if the field is the primary field; false if the field is a secondary\nfield.",
- "type": "boolean"
- },
- "source": {
- "$ref": "Source",
- "description": "The source of the field."
- }
- },
- "id": "FieldMetadata"
- },
- "Source": {
- "description": "The source of a field.",
- "type": "object",
- "properties": {
- "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/\u003cid\u003e where \u003cid\u003e is the source\nid.",
- "[Google Apps domain profile](https://admin.google.com).",
- "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cid\u003e where \u003cid\u003e is the source\nid."
- ],
- "enum": [
- "SOURCE_TYPE_UNSPECIFIED",
- "ACCOUNT",
- "PROFILE",
- "DOMAIN_PROFILE",
- "CONTACT"
- ],
- "description": "The source type.",
- "type": "string"
- },
- "etag": {
- "description": "The [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation. Only populated in\nperson.metadata.sources.",
- "type": "string"
- },
- "id": {
- "description": "The unique identifier within the source type generated by the server.",
- "type": "string"
- },
- "profileMetadata": {
- "$ref": "ProfileMetadata",
- "description": "Metadata about a source of type PROFILE."
- }
- },
- "id": "Source"
- },
- "PersonResponse": {
- "description": "The response for a single person",
- "type": "object",
- "properties": {
- "person": {
- "$ref": "Person",
- "description": "The person."
- },
- "httpStatusCode": {
- "description": "[HTTP 1.1 status code](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"
- },
- "RelationshipInterest": {
- "description": "A person's read-only relationship interest .",
- "type": "object",
- "properties": {
- "formattedValue": {
- "description": "The value of the relationship interest translated and formatted in the\nviewer's account locale or the locale specified in the Accept-Language\nHTTP header.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relationship interest."
- },
- "value": {
- "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`",
- "type": "string"
- }
- },
- "id": "RelationshipInterest"
- },
- "Relation": {
- "description": "A person's relation to another person.",
- "type": "object",
- "properties": {
- "person": {
- "description": "The name of the other person this relation refers to.",
- "type": "string"
- },
- "formattedType": {
- "description": "The type of the relation translated and formatted in the viewer's account\nlocale or the locale specified in the Accept-Language HTTP header.",
- "type": "string"
- },
- "metadata": {
- "$ref": "FieldMetadata",
- "description": "Metadata about the relation."
- },
- "type": {
- "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`",
- "type": "string"
- }
- },
- "id": "Relation"
- },
- "Occupation": {
- "description": "A person's occupation.",
- "type": "object",
- "properties": {
- "metadata": {
- "description": "Metadata about the occupation.",
- "$ref": "FieldMetadata"
- },
- "value": {
- "description": "The occupation; for example, `carpenter`.",
- "type": "string"
- }
- },
- "id": "Occupation"
}
},
"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://people.googleapis.com/",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/userinfo.profile": {
- "description": "View your basic profile info"
- },
- "https://www.googleapis.com/auth/user.addresses.read": {
- "description": "View your street addresses"
- },
- "https://www.googleapis.com/auth/contacts": {
- "description": "Manage your contacts"
- },
- "https://www.googleapis.com/auth/user.emails.read": {
- "description": "View your email addresses"
+ "https://www.googleapis.com/auth/user.phonenumbers.read": {
+ "description": "View your phone numbers"
},
"https://www.googleapis.com/auth/userinfo.email": {
"description": "View your email address"
},
- "https://www.googleapis.com/auth/user.phonenumbers.read": {
- "description": "View your phone numbers"
+ "https://www.googleapis.com/auth/user.birthday.read": {
+ "description": "View your complete date of birth"
},
"https://www.googleapis.com/auth/contacts.readonly": {
"description": "View your contacts"
},
- "https://www.googleapis.com/auth/user.birthday.read": {
- "description": "View your complete date of birth"
- },
"https://www.googleapis.com/auth/plus.login": {
"description": "Know the list of people in your circles, your age range, and language"
+ },
+ "https://www.googleapis.com/auth/userinfo.profile": {
+ "description": "View your basic profile info"
+ },
+ "https://www.googleapis.com/auth/user.emails.read": {
+ "description": "View your email addresses"
+ },
+ "https://www.googleapis.com/auth/contacts": {
+ "description": "Manage your contacts"
+ },
+ "https://www.googleapis.com/auth/user.addresses.read": {
+ "description": "View your street addresses"
}
}
}
@@ -1385,13 +1393,5 @@
"rootUrl": "https://people.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "people",
- "batchPath": "batch",
- "documentationLink": "https://developers.google.com/people/",
- "revision": "20170306",
- "id": "people:v1",
- "title": "Google People API",
- "discoveryVersion": "v1",
- "ownerName": "Google",
- "version_module": "True"
+ "name": "people"
}
diff --git a/playmoviespartner/v1/playmoviespartner-api.json b/playmoviespartner/v1/playmoviespartner-api.json
index cffe304..efd7ea3 100644
--- a/playmoviespartner/v1/playmoviespartner-api.json
+++ b/playmoviespartner/v1/playmoviespartner-api.json
@@ -1,954 +1,1031 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/uupf4ETIkmsQTW6dv4YK-4z-ZSI\"",
- "discoveryVersion": "v1",
- "id": "playmoviespartner:v1",
- "name": "playmoviespartner",
- "canonicalName": "Play Movies",
- "version": "v1",
- "revision": "20170119",
- "title": "Google Play Movies Partner API",
- "description": "Gets the delivery status of titles for Google Play Movies Partners.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/playmoviespartner/",
- "protocol": "rest",
- "baseUrl": "https://playmoviespartner.googleapis.com/",
- "basePath": "",
- "rootUrl": "https://playmoviespartner.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "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.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/playmovies_partner.readonly": {
- "description": "View the digital assets you publish on Google Play Movies and TV"
- }
- }
- }
- },
- "schemas": {
- "Avail": {
- "id": "Avail",
- "type": "object",
- "description": "An Avail describes the Availability Window of a specific Edit in a given country, which means the period Google is allowed to sell or rent the Edit. Avails are exposed in EMA format Version 1.6b (available at http://www.movielabs.com/md/avails/) Studios can see the Avails for the Titles they own. Post-production houses cannot see any Avails.",
- "properties": {
- "availId": {
- "type": "string",
- "description": "ID internally generated by Google to uniquely identify an Avail. Not part of EMA Specs."
- },
- "displayName": {
- "type": "string",
- "description": "The name of the studio that owns the Edit referred in the Avail. This is the equivalent of `studio_name` in other resources, but it follows the EMA nomenclature. Example: \"Google Films\"."
- },
- "storeLanguage": {
- "type": "string",
- "description": "Spoken language of the intended audience. Language shall be encoded in accordance with RFC 5646. Example: \"fr\"."
- },
- "territory": {
- "type": "string",
- "description": "ISO 3166-1 alpha-2 country code for the country or territory of this Avail. For Avails, we use Territory in lieu of Country to comply with EMA specifications. But please note that Territory and Country identify the same thing. Example: \"US\"."
- },
- "workType": {
- "type": "string",
- "description": "Work type as enumerated in EMA.",
- "enum": [
- "TITLE_TYPE_UNSPECIFIED",
- "MOVIE",
- "SEASON",
- "EPISODE",
- "BUNDLE"
- ]
- },
- "seriesTitleInternalAlias": {
- "type": "string",
- "description": "Title used by involved parties to refer to this series. Only available on TV Avails. Example: \"Googlers, The\"."
- },
- "seasonNumber": {
- "type": "string",
- "description": "The number assigned to the season within a series. Only available on TV Avails. Example: \"1\"."
- },
- "episodeNumber": {
- "type": "string",
- "description": "The number assigned to the episode within a season. Only available on TV Avails. Example: \"3\"."
- },
- "seasonTitleInternalAlias": {
- "type": "string",
- "description": "Title used by involved parties to refer to this season. Only available on TV Avails. Example: \"Googlers, The\"."
- },
- "episodeTitleInternalAlias": {
- "type": "string",
- "description": "OPTIONAL.TV Only. Title used by involved parties to refer to this episode. Only available on TV Avails. Example: \"Coding at Google\"."
- },
- "titleInternalAlias": {
- "type": "string",
- "description": "Title used by involved parties to refer to this content. Example: \"Googlers, The\". Only available on Movie Avails."
- },
- "licenseType": {
- "type": "string",
- "description": "Type of transaction.",
- "enum": [
- "LICENSE_TYPE_UNSPECIFIED",
- "EST",
- "VOD",
- "SVOD",
- "POEST"
- ]
- },
- "formatProfile": {
- "type": "string",
- "description": "Indicates the format profile covered by the transaction.",
- "enum": [
- "FORMAT_PROFILE_UNSPECIFIED",
- "SD",
- "HD",
- "UHD"
- ]
- },
- "start": {
- "type": "string",
- "description": "Start of term in YYYY-MM-DD format in the timezone of the country of the Avail. Example: \"2013-05-14\"."
- },
- "end": {
- "type": "string",
- "description": "End of term in YYYY-MM-DD format in the timezone of the country of the Avail. \"Open\" if no end date is available. Example: \"2019-02-17\""
- },
- "priceType": {
- "type": "string",
- "description": "Type of pricing that should be applied to this Avail based on how the partner classify them. Example: \"Tier\", \"WSP\", \"SRP\", or \"Category\"."
- },
- "priceValue": {
- "type": "string",
- "description": "Value to be applied to the pricing type. Example: \"4\" or \"2.99\""
- },
- "contentId": {
- "type": "string",
- "description": "Title Identifier. This should be the Title Level EIDR. Example: \"10.5240/1489-49A2-3956-4B2D-FE16-5\"."
- },
- "productId": {
- "type": "string",
- "description": "Edit Identifier. This should be the Edit Level EIDR. Example: \"10.2340/1489-49A2-3956-4B2D-FE16-6\""
- },
- "encodeId": {
- "type": "string",
- "description": "Manifestation Identifier. This should be the Manifestation Level EIDR. Example: \"10.2340/1489-49A2-3956-4B2D-FE16-7\""
- },
- "seriesAltId": {
- "type": "string",
- "description": "Other identifier referring to the series, as defined by partner. Only available on TV avails. Example: \"rs_googlers\"."
- },
- "seasonAltId": {
- "type": "string",
- "description": "Other identifier referring to the season, as defined by partner. Only available on TV avails. Example: \"rs_googlers_s1\"."
- },
- "episodeAltId": {
- "type": "string",
- "description": "Other identifier referring to the episode, as defined by partner. Only available on TV avails. Example: \"rs_googlers_s1_3\"."
- },
- "altId": {
- "type": "string",
- "description": "Other identifier referring to the Edit, as defined by partner. Example: \"GOOGLER_2006\""
- },
- "suppressionLiftDate": {
- "type": "string",
- "description": "First date an Edit could be publically announced as becoming available at a specific future date in territory of Avail. *Not* the Avail start date or pre-order start date. Format is YYYY-MM-DD. Only available for pre-orders. Example: \"2012-12-10\""
- },
- "releaseDate": {
- "type": "string",
- "description": "Release date of the Title in earliest released territory. Typically it is just the year, but it is free-form as per EMA spec. Examples: \"1979\", \"Oct 2014\""
- },
- "ratingSystem": {
- "type": "string",
- "description": "Rating system applied to the version of title within territory of Avail. Rating systems should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) Example: \"MPAA\""
- },
- "ratingValue": {
- "type": "string",
- "description": "Value representing the rating. Ratings should be formatted as per http://www.movielabs.com/md/ratings/ Example: \"PG\""
- },
- "ratingReason": {
- "type": "string",
- "description": "Value representing the rating reason. Rating reasons should be formatted as per [EMA ratings spec](http://www.movielabs.com/md/ratings/) and comma-separated for inclusion of multiple reasons. Example: \"L, S, V\""
- },
- "captionIncluded": {
- "type": "boolean",
- "description": "Communicating if caption file will be delivered."
- },
- "captionExemption": {
- "type": "string",
- "description": "Communicating an exempt category as defined by FCC regulations. It is not required for non-US Avails. Example: \"1\""
- },
- "videoId": {
- "type": "string",
- "description": "Google-generated ID identifying the video linked to this Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc'"
- },
- "pphNames": {
- "type": "array",
- "description": "Name of the post-production houses that manage the Avail. Not part of EMA Specs.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ListAvailsResponse": {
- "id": "ListAvailsResponse",
- "type": "object",
- "description": "Response to the 'ListAvails' method.",
- "properties": {
- "avails": {
- "type": "array",
- "description": "List of Avails that match the request criteria.",
- "items": {
- "$ref": "Avail"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field."
- },
- "totalSize": {
- "type": "integer",
- "description": "See _List methods rules_ for more information about this field.",
- "format": "int32"
- }
- }
- },
- "Order": {
- "id": "Order",
- "type": "object",
- "description": "An Order tracks the fulfillment of an Edit when delivered using the legacy, non-component-based delivery. Each Order is uniquely identified by an `order_id`, which is generated by Google. Externally, Orders can also be identified by partners using its `custom_id` (when provided).",
- "properties": {
- "orderId": {
- "type": "string",
- "description": "ID internally generated by Google to uniquely identify an Order. Example: 'abcde12_x'"
- },
- "customId": {
- "type": "string",
- "description": "ID that can be used to externally identify an Order. This ID is provided by partners when submitting the Avails. Example: 'GOOGLER_2006'"
- },
- "videoId": {
- "type": "string",
- "description": "Google-generated ID identifying the video linked to this Order, once delivered. Example: 'gtry456_xc'."
- },
- "countries": {
- "type": "array",
- "description": "Countries where the Order is available, using the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
- "items": {
- "type": "string"
- }
- },
- "type": {
- "type": "string",
- "description": "Type of the Edit linked to the Order.",
- "enum": [
- "TITLE_TYPE_UNSPECIFIED",
- "MOVIE",
- "SEASON",
- "EPISODE",
- "BUNDLE"
- ]
- },
- "name": {
- "type": "string",
- "description": "Default Edit name, usually in the language of the country of origin. Example: \"Googlers, The\"."
- },
- "episodeName": {
- "type": "string",
- "description": "Default Episode name, usually in the language of the country of origin. Only available for TV Edits Example: \"Googlers, The - Pilot\"."
- },
- "seasonName": {
- "type": "string",
- "description": "Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: \"Googlers, The - A Brave New World\"."
- },
- "showName": {
- "type": "string",
- "description": "Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: \"Googlers, The\"."
- },
- "status": {
- "type": "string",
- "description": "High-level status of the order.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "STATUS_APPROVED",
- "STATUS_FAILED",
- "STATUS_PROCESSING",
- "STATUS_UNFULFILLED",
- "STATUS_NOT_AVAILABLE"
- ]
- },
- "statusDetail": {
- "type": "string",
- "description": "Detailed status of the order",
- "enum": [
- "ORDER_STATUS_UNSPECIFIED",
- "ORDER_STATUS_QC_APPROVED",
- "ORDER_STATUS_QC_REJECTION",
- "ORDER_STATUS_INTERNAL_FIX",
- "ORDER_STATUS_OPEN_ORDER",
- "ORDER_STATUS_NOT_AVAILABLE",
- "ORDER_STATUS_AWAITING_REDELIVERY",
- "ORDER_STATUS_READY_FOR_QC",
- "ORDER_STATUS_FILE_PROCESSING"
- ]
- },
- "rejectionNote": {
- "type": "string",
- "description": "Field explaining why an Order has been rejected. Example: \"Trailer audio is 2ch mono, please re-deliver in stereo\"."
- },
- "orderedTime": {
- "type": "string",
- "description": "Timestamp when the Order was created."
- },
- "approvedTime": {
- "type": "string",
- "description": "Timestamp when the Order was approved."
- },
- "receivedTime": {
- "type": "string",
- "description": "Timestamp when the Order was fulfilled."
- },
- "earliestAvailStartTime": {
- "type": "string",
- "description": "Timestamp of the earliest start date of the Avails linked to this Order."
- },
- "priority": {
- "type": "number",
- "description": "Order priority, as defined by Google. The higher the value, the higher the priority. Example: 90",
- "format": "double"
- },
- "legacyPriority": {
- "type": "string",
- "description": "Legacy Order priority, as defined by Google. Example: 'P0'"
- },
- "channelId": {
- "type": "string",
- "description": "YouTube Channel ID that should be used to fulfill the Order. Example: \"UCRG64darCZhb\"."
- },
- "channelName": {
- "type": "string",
- "description": "YouTube Channel Name that should be used to fulfill the Order. Example: \"Google_channel\"."
- },
- "studioName": {
- "type": "string",
- "description": "Name of the studio that owns the Edit ordered."
- },
- "pphName": {
- "type": "string",
- "description": "Name of the post-production house that manages the Edit ordered."
- },
- "normalizedPriority": {
- "type": "string",
- "description": "A simpler representation of the priority.",
- "enum": [
- "NORMALIZED_PRIORITY_UNSPECIFIED",
- "LOW_PRIORITY",
- "HIGH_PRIORITY"
- ]
- }
- }
- },
- "ListOrdersResponse": {
- "id": "ListOrdersResponse",
- "type": "object",
- "description": "Response to the 'ListOrders' method.",
- "properties": {
- "orders": {
- "type": "array",
- "description": "List of Orders that match the request criteria.",
- "items": {
- "$ref": "Order"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field."
- },
- "totalSize": {
- "type": "integer",
- "description": "See _List methods rules_ for more information about this field.",
- "format": "int32"
- }
- }
- },
- "StoreInfo": {
- "id": "StoreInfo",
- "type": "object",
- "description": "Information about a playable sequence (video) associated with an Edit and available at the Google Play Store. Internally, each StoreInfo is uniquely identified by a `video_id` and `country`. Externally, Title-level EIDR or Edit-level EIDR, if provided, can also be used to identify a specific title or edit in a country.",
- "properties": {
- "videoId": {
- "type": "string",
- "description": "Google-generated ID identifying the video linked to the Edit. Example: 'gtry456_xc'"
- },
- "seasonId": {
- "type": "string",
- "description": "Google-generated ID identifying the season linked to the Edit. Only available for TV Edits. Example: 'ster23ex'"
- },
- "showId": {
- "type": "string",
- "description": "Google-generated ID identifying the show linked to the Edit. Only available for TV Edits. Example: 'et2hsue_x'"
- },
- "country": {
- "type": "string",
- "description": "Country where Edit is available in ISO 3166-1 alpha-2 country code. Example: \"US\"."
- },
- "liveTime": {
- "type": "string",
- "description": "Timestamp when the Edit went live on the Store."
- },
- "type": {
- "type": "string",
- "description": "Edit type, like Movie, Episode or Season.",
- "enum": [
- "TITLE_TYPE_UNSPECIFIED",
- "MOVIE",
- "SEASON",
- "EPISODE",
- "BUNDLE"
- ]
- },
- "name": {
- "type": "string",
- "description": "Default Edit name, usually in the language of the country of origin. Example: \"Googlers, The\"."
- },
- "titleLevelEidr": {
- "type": "string",
- "description": "Title-level EIDR ID. Example: \"10.5240/1489-49A2-3956-4B2D-FE16-5\"."
- },
- "editLevelEidr": {
- "type": "string",
- "description": "Edit-level EIDR ID. Example: \"10.5240/1489-49A2-3956-4B2D-FE16-6\"."
- },
- "seasonName": {
- "type": "string",
- "description": "Default Season name, usually in the language of the country of origin. Only available for TV Edits Example: \"Googlers, The - A Brave New World\"."
- },
- "showName": {
- "type": "string",
- "description": "Default Show name, usually in the language of the country of origin. Only available for TV Edits Example: \"Googlers, The\"."
- },
- "seasonNumber": {
- "type": "string",
- "description": "The number assigned to the season within a show. Only available on TV Edits. Example: \"1\"."
- },
- "episodeNumber": {
- "type": "string",
- "description": "The number assigned to the episode within a season. Only available on TV Edits. Example: \"1\"."
- },
- "hasSdOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a SD offer."
- },
- "hasHdOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a HD offer."
- },
- "hasVodOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a VOD offer."
- },
- "hasEstOffer": {
- "type": "boolean",
- "description": "Whether the Edit has a EST offer."
- },
- "hasAudio51": {
- "type": "boolean",
- "description": "Whether the Edit has a 5.1 channel audio track."
- },
- "audioTracks": {
- "type": "array",
- "description": "Audio tracks available for this Edit.",
- "items": {
- "type": "string"
- }
- },
- "subtitles": {
- "type": "array",
- "description": "Subtitles available for this Edit.",
- "items": {
- "type": "string"
- }
- },
- "hasInfoCards": {
- "type": "boolean",
- "description": "Whether the Edit has info cards."
- },
- "mid": {
- "type": "string",
- "description": "Knowledge Graph ID associated to this Edit, if available. This ID links the Edit to its knowledge entity, externally accessible at http://freebase.com. In the absense of Title EIDR or Edit EIDR, this ID helps link together multiple Edits across countries. Example: '/m/0ffx29'"
- },
- "trailerId": {
- "type": "string",
- "description": "Google-generated ID identifying the trailer linked to the Edit. Example: 'bhd_4e_cx'"
- },
- "studioName": {
- "type": "string",
- "description": "Name of the studio that owns the Edit ordered."
- },
- "pphNames": {
- "type": "array",
- "description": "Name of the post-production houses that manage the Edit.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "ListStoreInfosResponse": {
- "id": "ListStoreInfosResponse",
- "type": "object",
- "description": "Response to the 'ListStoreInfos' method.",
- "properties": {
- "storeInfos": {
- "type": "array",
- "description": "List of StoreInfos that match the request criteria.",
- "items": {
- "$ref": "StoreInfo"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "See 'List methods rules' for info about this field."
- },
- "totalSize": {
- "type": "integer",
- "description": "See _List methods rules_ for more information about this field.",
- "format": "int32"
- }
- }
- }
- },
- "resources": {
- "accounts": {
- "resources": {
- "avails": {
- "methods": {
- "get": {
- "id": "playmoviespartner.accounts.avails.get",
- "path": "v1/accounts/{accountId}/avails/{availId}",
- "httpMethod": "GET",
- "description": "Get an Avail given its avail group id and avail id.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
+ "discoveryVersion": "v1",
+ "ownerName": "Google",
+ "resources": {
+ "accounts": {
+ "resources": {
+ "avails": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "availId"
+ ],
+ "response": {
+ "$ref": "Avail"
+ },
+ "parameters": {
+ "availId": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "REQUIRED. Avail ID."
+ },
+ "accountId": {
+ "location": "path",
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "flatPath": "v1/accounts/{accountId}/avails/{availId}",
+ "id": "playmoviespartner.accounts.avails.get",
+ "path": "v1/accounts/{accountId}/avails/{availId}",
+ "description": "Get an Avail given its avail group id and avail id."
+ },
+ "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.",
+ "response": {
+ "$ref": "ListAvailsResponse"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "parameters": {
+ "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.",
+ "required": true,
+ "type": "string"
+ },
+ "territories": {
+ "type": "string",
+ "repeated": true,
+ "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\")."
+ },
+ "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"
+ },
+ "videoIds": {
+ "location": "query",
+ "description": "Filter Avails that match any of the given `video_id`s.",
+ "type": "string",
+ "repeated": true
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "altIds": {
+ "description": "Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "pphNames": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "repeated": true
+ }
+ },
+ "flatPath": "v1/accounts/{accountId}/avails",
+ "path": "v1/accounts/{accountId}/avails",
+ "id": "playmoviespartner.accounts.avails.list"
+ }
+ }
},
- "availId": {
- "type": "string",
- "description": "REQUIRED. Avail ID.",
- "required": true,
- "location": "path"
+ "orders": {
+ "methods": {
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Order"
+ },
+ "parameterOrder": [
+ "accountId",
+ "orderId"
+ ],
+ "parameters": {
+ "accountId": {
+ "location": "path",
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "required": true,
+ "type": "string"
+ },
+ "orderId": {
+ "description": "REQUIRED. Order ID.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "flatPath": "v1/accounts/{accountId}/orders/{orderId}",
+ "id": "playmoviespartner.accounts.orders.get",
+ "path": "v1/accounts/{accountId}/orders/{orderId}"
+ },
+ "list": {
+ "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.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOrdersResponse"
+ },
+ "parameterOrder": [
+ "accountId"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "videoIds": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Filter Orders that match any of the given `video_id`s."
+ },
+ "customId": {
+ "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "pphNames": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "status": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "STATUS_APPROVED",
+ "STATUS_FAILED",
+ "STATUS_PROCESSING",
+ "STATUS_UNFULFILLED",
+ "STATUS_NOT_AVAILABLE"
+ ],
+ "description": "Filter Orders that match one of the given status."
+ },
+ "name": {
+ "location": "query",
+ "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
+ "type": "string"
+ },
+ "studioNames": {
+ "repeated": true,
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "flatPath": "v1/accounts/{accountId}/orders",
+ "id": "playmoviespartner.accounts.orders.list",
+ "path": "v1/accounts/{accountId}/orders"
+ }
+ }
+ },
+ "storeInfos": {
+ "methods": {
+ "list": {
+ "parameters": {
+ "pphNames": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "repeated": true,
+ "location": "query"
+ },
+ "countries": {
+ "type": "string",
+ "repeated": true,
+ "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\")."
+ },
+ "studioNames": {
+ "repeated": true,
+ "location": "query",
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "name": {
+ "location": "query",
+ "description": "Filter that matches StoreInfos with a `name` or `show_name`\nthat contains the given case-insensitive name.",
+ "type": "string"
+ },
+ "accountId": {
+ "location": "path",
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "required": true,
+ "type": "string"
+ },
+ "seasonIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Filter StoreInfos that match any of the given `season_id`s.",
+ "type": "string"
+ },
+ "videoIds": {
+ "repeated": true,
+ "location": "query",
+ "description": "Filter StoreInfos that match any of the given `video_id`s.",
+ "type": "string"
+ },
+ "videoId": {
+ "location": "query",
+ "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"
+ },
+ "pageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "See _List methods rules_ for info about this field.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "mids": {
+ "type": "string",
+ "repeated": true,
+ "location": "query",
+ "description": "Filter StoreInfos that match any of the given `mid`s."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "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.",
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId"
+ ],
+ "response": {
+ "$ref": "ListStoreInfosResponse"
+ }
+ }
+ },
+ "resources": {
+ "country": {
+ "methods": {
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "accountId",
+ "videoId",
+ "country"
+ ],
+ "response": {
+ "$ref": "StoreInfo"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/playmovies_partner.readonly"
+ ],
+ "parameters": {
+ "accountId": {
+ "description": "REQUIRED. See _General rules_ for more information about this field.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "videoId": {
+ "location": "path",
+ "description": "REQUIRED. Video ID.",
+ "required": true,
+ "type": "string"
+ },
+ "country": {
+ "location": "path",
+ "description": "REQUIRED. Edit country.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
+ "id": "playmoviespartner.accounts.storeInfos.country.get",
+ "path": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
+ "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."
+ }
+ }
+ }
+ }
}
- },
- "parameterOrder": [
- "accountId",
- "availId"
- ],
- "response": {
- "$ref": "Avail"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
- },
- "list": {
- "id": "playmoviespartner.accounts.avails.list",
- "path": "v1/accounts/{accountId}/avails",
- "httpMethod": "GET",
- "description": "List Avails owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "See _List methods rules_ for info about this field.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "location": "query"
- },
- "pphNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
- },
- "studioNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
- },
- "title": {
- "type": "string",
- "description": "Filter that matches Avails with a `title_internal_alias`, `series_title_internal_alias`, `season_title_internal_alias`, or `episode_title_internal_alias` that contains the given case-insensitive title.",
- "location": "query"
- },
- "territories": {
- "type": "string",
- "description": "Filter Avails that match (case-insensitive) any of the given country codes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
- "repeated": true,
- "location": "query"
- },
- "altId": {
- "type": "string",
- "description": "Filter Avails that match a case-insensitive, partner-specific custom id. NOTE: this field is deprecated and will be removed on V2; `alt_ids` should be used instead.",
- "location": "query"
- },
- "videoIds": {
- "type": "string",
- "description": "Filter Avails that match any of the given `video_id`s.",
- "repeated": true,
- "location": "query"
- },
- "altIds": {
- "type": "string",
- "description": "Filter Avails that match (case-insensitive) any of the given partner-specific custom ids.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "ListAvailsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
}
- }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
},
- "orders": {
- "methods": {
- "get": {
- "id": "playmoviespartner.accounts.orders.get",
- "path": "v1/accounts/{accountId}/orders/{orderId}",
- "httpMethod": "GET",
- "description": "Get an Order given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
- },
- "orderId": {
- "type": "string",
- "description": "REQUIRED. Order ID.",
- "required": true,
- "location": "path"
- }
- },
- "parameterOrder": [
- "accountId",
- "orderId"
- ],
- "response": {
- "$ref": "Order"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
- },
- "list": {
- "id": "playmoviespartner.accounts.orders.list",
- "path": "v1/accounts/{accountId}/orders",
- "httpMethod": "GET",
- "description": "List Orders owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "See _List methods rules_ for info about this field.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "location": "query"
- },
- "pphNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
- },
- "studioNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
- },
- "name": {
- "type": "string",
- "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode` that contains the given case-insensitive name.",
- "location": "query"
- },
- "status": {
- "type": "string",
- "description": "Filter Orders that match one of the given status.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "STATUS_APPROVED",
- "STATUS_FAILED",
- "STATUS_PROCESSING",
- "STATUS_UNFULFILLED",
- "STATUS_NOT_AVAILABLE"
- ],
- "repeated": true,
- "location": "query"
- },
- "customId": {
- "type": "string",
- "description": "Filter Orders that match a case-insensitive, partner-specific custom id.",
- "location": "query"
- },
- "videoIds": {
- "type": "string",
- "description": "Filter Orders that match any of the given `video_id`s.",
- "repeated": true,
- "location": "query"
- }
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "ListOrdersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
- }
- }
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
- "storeInfos": {
- "methods": {
- "list": {
- "id": "playmoviespartner.accounts.storeInfos.list",
- "path": "v1/accounts/{accountId}/storeInfos",
- "httpMethod": "GET",
- "description": "List StoreInfos owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
+ "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": {
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ]
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "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": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ }
+ },
+ "schemas": {
+ "Order": {
+ "id": "Order",
+ "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": {
+ "pphName": {
+ "description": "Name of the post-production house that manages the Edit ordered.",
+ "type": "string"
},
- "pageSize": {
- "type": "integer",
- "description": "See _List methods rules_ for info about this field.",
- "format": "int32",
- "location": "query"
+ "legacyPriority": {
+ "type": "string",
+ "description": "Legacy Order priority, as defined by Google.\nExample: 'P0'"
},
- "pageToken": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "location": "query"
+ "orderedTime": {
+ "description": "Timestamp when the Order was created.",
+ "format": "google-datetime",
+ "type": "string"
},
- "pphNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
- },
- "studioNames": {
- "type": "string",
- "description": "See _List methods rules_ for info about this field.",
- "repeated": true,
- "location": "query"
+ "priority": {
+ "type": "number",
+ "description": "Order priority, as defined by Google.\nThe higher the value, the higher the priority.\nExample: 90",
+ "format": "double"
},
"videoId": {
- "type": "string",
- "description": "Filter StoreInfos that match a given `video_id`. NOTE: this field is deprecated and will be removed on V2; `video_ids` should be used instead.",
- "location": "query"
+ "description": "Google-generated ID identifying the video linked to this Order, once\ndelivered.\nExample: 'gtry456_xc'.",
+ "type": "string"
+ },
+ "episodeName": {
+ "description": "Default Episode name,\nusually in the language of the country of origin.\nOnly available for TV Edits\nExample: \"Googlers, The - Pilot\".",
+ "type": "string"
},
"countries": {
- "type": "string",
- "description": "Filter StoreInfos that match (case-insensitive) any of the given country codes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
- "repeated": true,
- "location": "query"
+ "description": "Countries where the Order is available,\nusing the \"ISO 3166-1 alpha-2\" format (example: \"US\").",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "statusDetail": {
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "Approved by Google's Quality Control team.",
+ "Rejected by Google's Quality Control team, pending partner redelivery.",
+ "Internal error while processing the Order.",
+ "Waiting for initial delivery from partner.",
+ "Used on Orders that do not have Status, like TV Seasons.",
+ "Waiting for re-delivery from partner.",
+ "Asset was delivered by partner, but is being reviewed by Google's\nQuality Control team.",
+ "Waiting for Google to process the asset."
+ ],
+ "enum": [
+ "ORDER_STATUS_UNSPECIFIED",
+ "ORDER_STATUS_QC_APPROVED",
+ "ORDER_STATUS_QC_REJECTION",
+ "ORDER_STATUS_INTERNAL_FIX",
+ "ORDER_STATUS_OPEN_ORDER",
+ "ORDER_STATUS_NOT_AVAILABLE",
+ "ORDER_STATUS_AWAITING_REDELIVERY",
+ "ORDER_STATUS_READY_FOR_QC",
+ "ORDER_STATUS_FILE_PROCESSING"
+ ],
+ "description": "Detailed status of the order",
+ "type": "string"
+ },
+ "earliestAvailStartTime": {
+ "description": "Timestamp of the earliest start date of the Avails\nlinked to this Order.",
+ "format": "google-datetime",
+ "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.",
+ "Waiting for partner to re-deliver the asset after a rejection by Google.",
+ "Waiting for Google to process the asset.",
+ "Waiting for partner to deliver the asset.",
+ "Used when Status is not available (i.e: Orders for TV Seasons)."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "STATUS_APPROVED",
+ "STATUS_FAILED",
+ "STATUS_PROCESSING",
+ "STATUS_UNFULFILLED",
+ "STATUS_NOT_AVAILABLE"
+ ]
},
"name": {
- "type": "string",
- "description": "Filter that matches StoreInfos with a `name` or `show_name` that contains the given case-insensitive name.",
- "location": "query"
+ "description": "Default Edit name,\nusually in the language of the country of origin.\nExample: \"Googlers, The\".",
+ "type": "string"
},
- "videoIds": {
- "type": "string",
- "description": "Filter StoreInfos that match any of the given `video_id`s.",
- "repeated": true,
- "location": "query"
+ "studioName": {
+ "description": "Name of the studio that owns the Edit ordered.",
+ "type": "string"
},
- "mids": {
- "type": "string",
- "description": "Filter StoreInfos that match any of the given `mid`s.",
- "repeated": true,
- "location": "query"
+ "receivedTime": {
+ "type": "string",
+ "description": "Timestamp when the Order was fulfilled.",
+ "format": "google-datetime"
},
- "seasonIds": {
- "type": "string",
- "description": "Filter StoreInfos that match any of the given `season_id`s.",
- "repeated": true,
- "location": "query"
+ "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": {
+ "description": "Timestamp when the Order was approved.",
+ "format": "google-datetime",
+ "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": {
+ "enum": [
+ "NORMALIZED_PRIORITY_UNSPECIFIED",
+ "LOW_PRIORITY",
+ "HIGH_PRIORITY"
+ ],
+ "description": "A simpler representation of the priority.",
+ "type": "string",
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "A low-priority asset, typically from a library movie.",
+ "A high-priority asset, typically from a new release or box office hit."
+ ]
+ },
+ "orderId": {
+ "description": "ID internally generated by Google to uniquely identify an Order.\nExample: 'abcde12_x'",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "A movie picture.",
+ "A season of a TV show.",
+ "An episode of a TV show.",
+ "A collection of movies, i.e. \"Googlers 1 and Googlers, the return\""
+ ],
+ "enum": [
+ "TITLE_TYPE_UNSPECIFIED",
+ "MOVIE",
+ "SEASON",
+ "EPISODE",
+ "BUNDLE"
+ ],
+ "description": "Type of the Edit linked to the Order.",
+ "type": "string"
+ },
+ "rejectionNote": {
+ "description": "Field explaining why an Order has been rejected.\nExample: \"Trailer audio is 2ch mono, please re-deliver in stereo\".",
+ "type": "string"
+ },
+ "channelId": {
+ "description": "YouTube Channel ID that should be used to fulfill the Order.\nExample: \"UCRG64darCZhb\".",
+ "type": "string"
}
- },
- "parameterOrder": [
- "accountId"
- ],
- "response": {
- "$ref": "ListStoreInfosResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
}
- },
- "resources": {
- "country": {
- "methods": {
- "get": {
- "id": "playmoviespartner.accounts.storeInfos.country.get",
- "path": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
- "httpMethod": "GET",
- "description": "Get a StoreInfo given its video id and country. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.",
- "parameters": {
- "accountId": {
- "type": "string",
- "description": "REQUIRED. See _General rules_ for more information about this field.",
- "required": true,
- "location": "path"
- },
- "videoId": {
- "type": "string",
- "description": "REQUIRED. Video ID.",
- "required": true,
- "location": "path"
- },
- "country": {
- "type": "string",
- "description": "REQUIRED. Edit country.",
- "required": true,
- "location": "path"
+ },
+ "ListStoreInfosResponse": {
+ "id": "ListStoreInfosResponse",
+ "description": "Response to the 'ListStoreInfos' method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "See 'List methods rules' for info about this field.",
+ "type": "string"
+ },
+ "storeInfos": {
+ "description": "List of StoreInfos that match the request criteria.",
+ "type": "array",
+ "items": {
+ "$ref": "StoreInfo"
}
- },
- "parameterOrder": [
- "accountId",
- "videoId",
- "country"
- ],
- "response": {
- "$ref": "StoreInfo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/playmovies_partner.readonly"
- ]
+ },
+ "totalSize": {
+ "description": "See _List methods rules_ for more information about this field.",
+ "format": "int32",
+ "type": "integer"
}
- }
}
- }
+ },
+ "ListAvailsResponse": {
+ "properties": {
+ "totalSize": {
+ "description": "See _List methods rules_ for more information about this field.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "avails": {
+ "type": "array",
+ "items": {
+ "$ref": "Avail"
+ },
+ "description": "List of Avails that match the request criteria."
+ },
+ "nextPageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ }
+ },
+ "id": "ListAvailsResponse",
+ "description": "Response to the 'ListAvails' method.",
+ "type": "object"
+ },
+ "Avail": {
+ "properties": {
+ "workType": {
+ "enum": [
+ "TITLE_TYPE_UNSPECIFIED",
+ "MOVIE",
+ "SEASON",
+ "EPISODE",
+ "BUNDLE"
+ ],
+ "description": "Work type as enumerated in EMA.",
+ "type": "string",
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "A movie picture.",
+ "A season of a TV show.",
+ "An episode of a TV show.",
+ "A collection of movies, i.e. \"Googlers 1 and Googlers, the return\""
+ ]
+ },
+ "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"
+ },
+ "suppressionLiftDate": {
+ "description": "First date an Edit could be publically announced as becoming\navailable at a specific future date in territory of Avail.\n*Not* the Avail start date or pre-order start date.\nFormat is YYYY-MM-DD.\nOnly available for pre-orders.\nExample: \"2012-12-10\"",
+ "type": "string"
+ },
+ "seasonAltId": {
+ "description": "Other identifier referring to the season, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers_s1\".",
+ "type": "string"
+ },
+ "encodeId": {
+ "description": "Manifestation Identifier. This should be the Manifestation\nLevel EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-7\"",
+ "type": "string"
+ },
+ "priceType": {
+ "type": "string",
+ "description": "Type of pricing that should be applied to this Avail\nbased on how the partner classify them.\nExample: \"Tier\", \"WSP\", \"SRP\", or \"Category\"."
+ },
+ "captionIncluded": {
+ "description": "Communicating if caption file will be delivered.",
+ "type": "boolean"
+ },
+ "licenseType": {
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "Electronic Sell Through - purchase policy for unlimited viewing.",
+ "Video On Demand - rental policy for temporary viewing.",
+ "Subscription Video On Demand - used for subscription platforms.\nNot supported on Google Play.",
+ "Pre-order Electronic Sell Through - pre-order purchase only window."
+ ],
+ "enum": [
+ "LICENSE_TYPE_UNSPECIFIED",
+ "EST",
+ "VOD",
+ "SVOD",
+ "POEST"
+ ],
+ "description": "Type of transaction.",
+ "type": "string"
+ },
+ "seasonNumber": {
+ "description": "The number assigned to the season within a series.\nOnly available on TV Avails.\nExample: \"1\".",
+ "type": "string"
+ },
+ "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": {
+ "type": "string",
+ "description": "Start of term in YYYY-MM-DD format in the timezone of the\ncountry of the Avail.\nExample: \"2013-05-14\"."
+ },
+ "ratingSystem": {
+ "description": "Rating system applied to the version of title within territory\nof Avail.\nRating systems should be formatted as per\n[EMA ratings spec](http://www.movielabs.com/md/ratings/)\nExample: \"MPAA\"",
+ "type": "string"
+ },
+ "pphNames": {
+ "description": "Name of the post-production houses that manage the Avail.\nNot part of EMA Specs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "seriesAltId": {
+ "description": "Other identifier referring to the series, as defined by partner.\nOnly available on TV avails.\nExample: \"rs_googlers\".",
+ "type": "string"
+ },
+ "altId": {
+ "description": "Other identifier referring to the Edit, as defined by partner.\nExample: \"GOOGLER_2006\"",
+ "type": "string"
+ },
+ "episodeNumber": {
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Avails.\nExample: \"3\".",
+ "type": "string"
+ },
+ "seriesTitleInternalAlias": {
+ "description": "Title used by involved parties to refer to this series.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "formatProfile": {
+ "description": "Indicates the format profile covered by the transaction.",
+ "type": "string",
+ "enumDescriptions": [
+ "Value could not be determined, please contact technical support if\nit should.",
+ "Standard-definition format.",
+ "High-definition format.",
+ "4K UHD."
+ ],
+ "enum": [
+ "FORMAT_PROFILE_UNSPECIFIED",
+ "SD",
+ "HD",
+ "UHD"
+ ]
+ },
+ "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"
+ },
+ "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"
+ },
+ "productId": {
+ "description": "Edit Identifier. This should be the Edit Level EIDR.\nExample: \"10.2340/1489-49A2-3956-4B2D-FE16-6\"",
+ "type": "string"
+ },
+ "seasonTitleInternalAlias": {
+ "description": "Title used by involved parties to refer to this season.\nOnly available on TV Avails.\nExample: \"Googlers, The\".",
+ "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"
+ }
+ },
+ "id": "Avail",
+ "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"
+ },
+ "ListOrdersResponse": {
+ "properties": {
+ "orders": {
+ "description": "List of Orders that match the request criteria.",
+ "type": "array",
+ "items": {
+ "$ref": "Order"
+ }
+ },
+ "nextPageToken": {
+ "description": "See _List methods rules_ for info about this field.",
+ "type": "string"
+ },
+ "totalSize": {
+ "description": "See _List methods rules_ for more information about this field.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ListOrdersResponse",
+ "description": "Response to the 'ListOrders' method.",
+ "type": "object"
+ },
+ "StoreInfo": {
+ "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": {
+ "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"
+ },
+ "videoId": {
+ "description": "Google-generated ID identifying the video linked to the Edit.\nExample: 'gtry456_xc'",
+ "type": "string"
+ },
+ "liveTime": {
+ "description": "Timestamp when the Edit went live on the Store.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "hasInfoCards": {
+ "type": "boolean",
+ "description": "Whether the Edit has info cards."
+ },
+ "hasVodOffer": {
+ "description": "Whether the Edit has a VOD offer.",
+ "type": "boolean"
+ },
+ "pphNames": {
+ "description": "Name of the post-production houses that manage the Edit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "episodeNumber": {
+ "description": "The number assigned to the episode within a season.\nOnly available on TV Edits.\nExample: \"1\".",
+ "type": "string"
+ },
+ "studioName": {
+ "type": "string",
+ "description": "Name of the studio that owns the Edit ordered."
+ },
+ "subtitles": {
+ "description": "Subtitles available for this Edit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "audioTracks": {
+ "description": "Audio tracks available for this Edit.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "showName": {
+ "description": "Default Show name, usually in the language of the country of\norigin.\nOnly available for TV Edits\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "country": {
+ "description": "Country where Edit is available in ISO 3166-1 alpha-2 country\ncode.\nExample: \"US\".",
+ "type": "string"
+ },
+ "showId": {
+ "type": "string",
+ "description": "Google-generated ID identifying the show linked to the Edit.\nOnly available for TV Edits.\nExample: 'et2hsue_x'"
+ },
+ "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.",
+ "A season of a TV show.",
+ "An episode of a TV show.",
+ "A collection of movies, i.e. \"Googlers 1 and Googlers, the return\""
+ ],
+ "enum": [
+ "TITLE_TYPE_UNSPECIFIED",
+ "MOVIE",
+ "SEASON",
+ "EPISODE",
+ "BUNDLE"
+ ]
+ },
+ "trailerId": {
+ "description": "Google-generated ID identifying the trailer linked to the Edit.\nExample: 'bhd_4e_cx'",
+ "type": "string"
+ },
+ "hasHdOffer": {
+ "description": "Whether the Edit has a HD offer.",
+ "type": "boolean"
+ },
+ "mid": {
+ "description": "Knowledge Graph ID associated to this Edit, if available.\nThis ID links the Edit to its knowledge entity, externally accessible\nat http://freebase.com.\nIn the absense of Title EIDR or Edit EIDR, this ID helps link together\nmultiple Edits across countries.\nExample: '/m/0ffx29'",
+ "type": "string"
+ },
+ "hasAudio51": {
+ "description": "Whether the Edit has a 5.1 channel audio track.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Default Edit name, usually in the language of the country of\norigin.\nExample: \"Googlers, The\".",
+ "type": "string"
+ },
+ "seasonId": {
+ "description": "Google-generated ID identifying the season linked to the Edit.\nOnly available for TV Edits.\nExample: 'ster23ex'",
+ "type": "string"
+ },
+ "titleLevelEidr": {
+ "description": "Title-level EIDR ID.\nExample: \"10.5240/1489-49A2-3956-4B2D-FE16-5\".",
+ "type": "string"
+ },
+ "seasonName": {
+ "type": "string",
+ "description": "Default Season name, usually in the language of the country of\norigin.\nOnly available for TV Edits\nExample: \"Googlers, The - A Brave New World\"."
+ }
+ },
+ "id": "StoreInfo"
}
- }
- }
- }
+ },
+ "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://playmoviespartner.googleapis.com/",
+ "canonicalName": "Play Movies",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/playmovies_partner.readonly": {
+ "description": "View the digital assets you publish on Google Play Movies and TV"
+ }
+ }
+ }
+ },
+ "servicePath": "",
+ "description": "Gets the delivery status of titles for Google Play Movies Partners.",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://playmoviespartner.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "playmoviespartner",
+ "batchPath": "batch",
+ "id": "playmoviespartner:v1",
+ "documentationLink": "https://developers.google.com/playmoviespartner/",
+ "revision": "20170228",
+ "title": "Google Play Movies Partner API"
}
diff --git a/playmoviespartner/v1/playmoviespartner-gen.go b/playmoviespartner/v1/playmoviespartner-gen.go
index c7ee383..5db5ac8 100644
--- a/playmoviespartner/v1/playmoviespartner-gen.go
+++ b/playmoviespartner/v1/playmoviespartner-gen.go
@@ -138,56 +138,77 @@
}
// Avail: An Avail describes the Availability Window of a specific Edit
-// in a given country, which means the period Google is allowed to sell
-// or rent the Edit. Avails are exposed in EMA format Version 1.6b
-// (available at http://www.movielabs.com/md/avails/) Studios can see
-// the Avails for the Titles they own. Post-production houses cannot see
-// any Avails.
+// in a given
+// country, which means the period Google is allowed to sell or rent the
+// Edit.
+//
+// Avails are exposed in EMA format Version 1.6b (available
+// at
+// http://www.movielabs.com/md/avails/)
+//
+// Studios can see the Avails for the Titles they own.
+// Post-production houses cannot see any Avails.
type Avail struct {
- // AltId: Other identifier referring to the Edit, as defined by partner.
+ // AltId: Other identifier referring to the Edit, as defined by
+ // partner.
// Example: "GOOGLER_2006"
AltId string `json:"altId,omitempty"`
// AvailId: ID internally generated by Google to uniquely identify an
- // Avail. Not part of EMA Specs.
+ // Avail.
+ // Not part of EMA Specs.
AvailId string `json:"availId,omitempty"`
// CaptionExemption: Communicating an exempt category as defined by FCC
- // regulations. It is not required for non-US Avails. Example: "1"
+ // regulations.
+ // It is not required for non-US Avails.
+ // Example: "1"
CaptionExemption string `json:"captionExemption,omitempty"`
// CaptionIncluded: Communicating if caption file will be delivered.
CaptionIncluded bool `json:"captionIncluded,omitempty"`
- // ContentId: Title Identifier. This should be the Title Level EIDR.
+ // ContentId: Title Identifier. This should be the Title Level
+ // EIDR.
// Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
ContentId string `json:"contentId,omitempty"`
// DisplayName: The name of the studio that owns the Edit referred in
- // the Avail. This is the equivalent of `studio_name` in other
- // resources, but it follows the EMA nomenclature. Example: "Google
- // Films".
+ // the Avail.
+ // This is the equivalent of `studio_name` in other resources, but it
+ // follows
+ // the EMA nomenclature.
+ // Example: "Google Films".
DisplayName string `json:"displayName,omitempty"`
- // EncodeId: Manifestation Identifier. This should be the Manifestation
- // Level EIDR. Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"
+ // EncodeId: Manifestation Identifier. This should be the
+ // Manifestation
+ // Level EIDR.
+ // Example: "10.2340/1489-49A2-3956-4B2D-FE16-7"
EncodeId string `json:"encodeId,omitempty"`
- // End: End of term in YYYY-MM-DD format in the timezone of the country
- // of the Avail. "Open" if no end date is available. Example:
- // "2019-02-17"
+ // End: End of term in YYYY-MM-DD format in the timezone of the
+ // country
+ // of the Avail.
+ // "Open" if no end date is available.
+ // Example: "2019-02-17"
End string `json:"end,omitempty"`
// EpisodeAltId: Other identifier referring to the episode, as defined
- // by partner. Only available on TV avails. Example: "rs_googlers_s1_3".
+ // by partner.
+ // Only available on TV avails.
+ // Example: "rs_googlers_s1_3".
EpisodeAltId string `json:"episodeAltId,omitempty"`
- // EpisodeNumber: The number assigned to the episode within a season.
- // Only available on TV Avails. Example: "3".
+ // EpisodeNumber: The number assigned to the episode within a
+ // season.
+ // Only available on TV Avails.
+ // Example: "3".
EpisodeNumber string `json:"episodeNumber,omitempty"`
// EpisodeTitleInternalAlias: OPTIONAL.TV Only. Title used by involved
- // parties to refer to this episode. Only available on TV Avails.
+ // parties to refer to this episode.
+ // Only available on TV Avails.
// Example: "Coding at Google".
EpisodeTitleInternalAlias string `json:"episodeTitleInternalAlias,omitempty"`
@@ -195,115 +216,160 @@
// transaction.
//
// Possible values:
- // "FORMAT_PROFILE_UNSPECIFIED"
- // "SD"
- // "HD"
- // "UHD"
+ // "FORMAT_PROFILE_UNSPECIFIED" - Value could not be determined,
+ // please contact technical support if
+ // it should.
+ // "SD" - Standard-definition format.
+ // "HD" - High-definition format.
+ // "UHD" - 4K UHD.
FormatProfile string `json:"formatProfile,omitempty"`
// LicenseType: Type of transaction.
//
// Possible values:
- // "LICENSE_TYPE_UNSPECIFIED"
- // "EST"
- // "VOD"
- // "SVOD"
- // "POEST"
+ // "LICENSE_TYPE_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "EST" - Electronic Sell Through - purchase policy for unlimited
+ // viewing.
+ // "VOD" - Video On Demand - rental policy for temporary viewing.
+ // "SVOD" - Subscription Video On Demand - used for subscription
+ // platforms.
+ // Not supported on Google Play.
+ // "POEST" - Pre-order Electronic Sell Through - pre-order purchase
+ // only window.
LicenseType string `json:"licenseType,omitempty"`
- // PphNames: Name of the post-production houses that manage the Avail.
+ // PphNames: Name of the post-production houses that manage the
+ // Avail.
// Not part of EMA Specs.
PphNames []string `json:"pphNames,omitempty"`
- // PriceType: Type of pricing that should be applied to this Avail based
- // on how the partner classify them. Example: "Tier", "WSP", "SRP", or
- // "Category".
+ // PriceType: Type of pricing that should be applied to this Avail
+ // based on how the partner classify them.
+ // Example: "Tier", "WSP", "SRP", or "Category".
PriceType string `json:"priceType,omitempty"`
- // PriceValue: Value to be applied to the pricing type. Example: "4" or
- // "2.99"
+ // PriceValue: Value to be applied to the pricing type.
+ // Example: "4" or "2.99"
PriceValue string `json:"priceValue,omitempty"`
- // ProductId: Edit Identifier. This should be the Edit Level EIDR.
+ // ProductId: Edit Identifier. This should be the Edit Level
+ // EIDR.
// Example: "10.2340/1489-49A2-3956-4B2D-FE16-6"
ProductId string `json:"productId,omitempty"`
- // RatingReason: Value representing the rating reason. Rating reasons
- // should be formatted as per [EMA ratings
- // spec](http://www.movielabs.com/md/ratings/) and comma-separated for
- // inclusion of multiple reasons. Example: "L, S, V"
+ // RatingReason: Value representing the rating reason.
+ // Rating reasons should be formatted as per
+ // [EMA ratings spec](http://www.movielabs.com/md/ratings/)
+ // and comma-separated for inclusion of multiple reasons.
+ // Example: "L, S, V"
RatingReason string `json:"ratingReason,omitempty"`
// RatingSystem: Rating system applied to the version of title within
- // territory of Avail. Rating systems should be formatted as per [EMA
- // ratings spec](http://www.movielabs.com/md/ratings/) Example: "MPAA"
+ // territory
+ // of Avail.
+ // Rating systems should be formatted as per
+ // [EMA ratings spec](http://www.movielabs.com/md/ratings/)
+ // Example: "MPAA"
RatingSystem string `json:"ratingSystem,omitempty"`
- // RatingValue: Value representing the rating. Ratings should be
- // formatted as per http://www.movielabs.com/md/ratings/ Example: "PG"
+ // RatingValue: Value representing the rating.
+ // Ratings should be formatted as per
+ // http://www.movielabs.com/md/ratings/
+ // Example: "PG"
RatingValue string `json:"ratingValue,omitempty"`
// ReleaseDate: Release date of the Title in earliest released
- // territory. Typically it is just the year, but it is free-form as per
- // EMA spec. Examples: "1979", "Oct 2014"
+ // territory.
+ // Typically it is just the year, but it is free-form as per EMA
+ // spec.
+ // Examples: "1979", "Oct 2014"
ReleaseDate string `json:"releaseDate,omitempty"`
// SeasonAltId: Other identifier referring to the season, as defined by
- // partner. Only available on TV avails. Example: "rs_googlers_s1".
+ // partner.
+ // Only available on TV avails.
+ // Example: "rs_googlers_s1".
SeasonAltId string `json:"seasonAltId,omitempty"`
- // SeasonNumber: The number assigned to the season within a series. Only
- // available on TV Avails. Example: "1".
+ // SeasonNumber: The number assigned to the season within a series.
+ // Only available on TV Avails.
+ // Example: "1".
SeasonNumber string `json:"seasonNumber,omitempty"`
// SeasonTitleInternalAlias: Title used by involved parties to refer to
- // this season. Only available on TV Avails. Example: "Googlers, The".
+ // this season.
+ // Only available on TV Avails.
+ // Example: "Googlers, The".
SeasonTitleInternalAlias string `json:"seasonTitleInternalAlias,omitempty"`
// SeriesAltId: Other identifier referring to the series, as defined by
- // partner. Only available on TV avails. Example: "rs_googlers".
+ // partner.
+ // Only available on TV avails.
+ // Example: "rs_googlers".
SeriesAltId string `json:"seriesAltId,omitempty"`
// SeriesTitleInternalAlias: Title used by involved parties to refer to
- // this series. Only available on TV Avails. Example: "Googlers, The".
+ // this series.
+ // Only available on TV Avails.
+ // Example: "Googlers, The".
SeriesTitleInternalAlias string `json:"seriesTitleInternalAlias,omitempty"`
- // Start: Start of term in YYYY-MM-DD format in the timezone of the
- // country of the Avail. Example: "2013-05-14".
+ // Start: Start of term in YYYY-MM-DD format in the timezone of
+ // the
+ // country of the Avail.
+ // Example: "2013-05-14".
Start string `json:"start,omitempty"`
- // StoreLanguage: Spoken language of the intended audience. Language
- // shall be encoded in accordance with RFC 5646. Example: "fr".
+ // StoreLanguage: Spoken language of the intended audience.
+ // Language shall be encoded in accordance with RFC 5646.
+ // Example: "fr".
StoreLanguage string `json:"storeLanguage,omitempty"`
// SuppressionLiftDate: First date an Edit could be publically announced
- // as becoming available at a specific future date in territory of
- // Avail. *Not* the Avail start date or pre-order start date. Format is
- // YYYY-MM-DD. Only available for pre-orders. Example: "2012-12-10"
+ // as becoming
+ // available at a specific future date in territory of Avail.
+ // *Not* the Avail start date or pre-order start date.
+ // Format is YYYY-MM-DD.
+ // Only available for pre-orders.
+ // Example: "2012-12-10"
SuppressionLiftDate string `json:"suppressionLiftDate,omitempty"`
// Territory: ISO 3166-1 alpha-2 country code for the country or
- // territory of this Avail. For Avails, we use Territory in lieu of
- // Country to comply with EMA specifications. But please note that
- // Territory and Country identify the same thing. Example: "US".
+ // territory
+ // of this Avail.
+ // For Avails, we use Territory in lieu of Country to comply with
+ // EMA specifications.
+ // But please note that Territory and Country identify the same
+ // thing.
+ // Example: "US".
Territory string `json:"territory,omitempty"`
// TitleInternalAlias: Title used by involved parties to refer to this
- // content. Example: "Googlers, The". Only available on Movie Avails.
+ // content.
+ // Example: "Googlers, The".
+ // Only available on Movie Avails.
TitleInternalAlias string `json:"titleInternalAlias,omitempty"`
// VideoId: Google-generated ID identifying the video linked to this
- // Avail, once delivered. Not part of EMA Specs. Example: 'gtry456_xc'
+ // Avail, once
+ // delivered.
+ // Not part of EMA Specs.
+ // Example: 'gtry456_xc'
VideoId string `json:"videoId,omitempty"`
// WorkType: Work type as enumerated in EMA.
//
// Possible values:
- // "TITLE_TYPE_UNSPECIFIED"
- // "MOVIE"
- // "SEASON"
- // "EPISODE"
- // "BUNDLE"
+ // "TITLE_TYPE_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "MOVIE" - A movie picture.
+ // "SEASON" - A season of a TV show.
+ // "EPISODE" - An episode of a TV show.
+ // "BUNDLE" - A collection of movies, i.e. "Googlers 1 and Googlers,
+ // the return"
WorkType string `json:"workType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -451,58 +517,74 @@
}
// Order: An Order tracks the fulfillment of an Edit when delivered
-// using the legacy, non-component-based delivery. Each Order is
-// uniquely identified by an `order_id`, which is generated by Google.
+// using the
+// legacy, non-component-based delivery.
+//
+// Each Order is uniquely identified by an `order_id`, which is
+// generated
+// by Google.
+//
// Externally, Orders can also be identified by partners using its
-// `custom_id` (when provided).
+// `custom_id`
+// (when provided).
type Order struct {
// ApprovedTime: Timestamp when the Order was approved.
ApprovedTime string `json:"approvedTime,omitempty"`
// ChannelId: YouTube Channel ID that should be used to fulfill the
- // Order. Example: "UCRG64darCZhb".
+ // Order.
+ // Example: "UCRG64darCZhb".
ChannelId string `json:"channelId,omitempty"`
// ChannelName: YouTube Channel Name that should be used to fulfill the
- // Order. Example: "Google_channel".
+ // Order.
+ // Example: "Google_channel".
ChannelName string `json:"channelName,omitempty"`
- // Countries: Countries where the Order is available, using the "ISO
- // 3166-1 alpha-2" format (example: "US").
+ // Countries: Countries where the Order is available,
+ // using the "ISO 3166-1 alpha-2" format (example: "US").
Countries []string `json:"countries,omitempty"`
- // CustomId: ID that can be used to externally identify an Order. This
- // ID is provided by partners when submitting the Avails. Example:
- // 'GOOGLER_2006'
+ // CustomId: ID that can be used to externally identify an Order.
+ // This ID is provided by partners when submitting the Avails.
+ // Example: 'GOOGLER_2006'
CustomId string `json:"customId,omitempty"`
// EarliestAvailStartTime: Timestamp of the earliest start date of the
- // Avails linked to this Order.
+ // Avails
+ // linked to this Order.
EarliestAvailStartTime string `json:"earliestAvailStartTime,omitempty"`
- // EpisodeName: Default Episode name, usually in the language of the
- // country of origin. Only available for TV Edits Example: "Googlers,
- // The - Pilot".
+ // EpisodeName: Default Episode name,
+ // usually in the language of the country of origin.
+ // Only available for TV Edits
+ // Example: "Googlers, The - Pilot".
EpisodeName string `json:"episodeName,omitempty"`
- // LegacyPriority: Legacy Order priority, as defined by Google. Example:
- // 'P0'
+ // LegacyPriority: Legacy Order priority, as defined by Google.
+ // Example: 'P0'
LegacyPriority string `json:"legacyPriority,omitempty"`
- // Name: Default Edit name, usually in the language of the country of
- // origin. Example: "Googlers, The".
+ // Name: Default Edit name,
+ // usually in the language of the country of origin.
+ // Example: "Googlers, The".
Name string `json:"name,omitempty"`
// NormalizedPriority: A simpler representation of the priority.
//
// Possible values:
- // "NORMALIZED_PRIORITY_UNSPECIFIED"
- // "LOW_PRIORITY"
- // "HIGH_PRIORITY"
+ // "NORMALIZED_PRIORITY_UNSPECIFIED" - Value could not be determined,
+ // please contact technical support if
+ // it should.
+ // "LOW_PRIORITY" - A low-priority asset, typically from a library
+ // movie.
+ // "HIGH_PRIORITY" - A high-priority asset, typically from a new
+ // release or box office hit.
NormalizedPriority string `json:"normalizedPriority,omitempty"`
// OrderId: ID internally generated by Google to uniquely identify an
- // Order. Example: 'abcde12_x'
+ // Order.
+ // Example: 'abcde12_x'
OrderId string `json:"orderId,omitempty"`
// OrderedTime: Timestamp when the Order was created.
@@ -512,49 +594,69 @@
// ordered.
PphName string `json:"pphName,omitempty"`
- // Priority: Order priority, as defined by Google. The higher the value,
- // the higher the priority. Example: 90
+ // Priority: Order priority, as defined by Google.
+ // The higher the value, the higher the priority.
+ // Example: 90
Priority float64 `json:"priority,omitempty"`
// ReceivedTime: Timestamp when the Order was fulfilled.
ReceivedTime string `json:"receivedTime,omitempty"`
- // RejectionNote: Field explaining why an Order has been rejected.
+ // RejectionNote: Field explaining why an Order has been
+ // rejected.
// Example: "Trailer audio is 2ch mono, please re-deliver in stereo".
RejectionNote string `json:"rejectionNote,omitempty"`
- // SeasonName: Default Season name, usually in the language of the
- // country of origin. Only available for TV Edits Example: "Googlers,
- // The - A Brave New World".
+ // SeasonName: Default Season name,
+ // usually in the language of the country of origin.
+ // Only available for TV Edits
+ // Example: "Googlers, The - A Brave New World".
SeasonName string `json:"seasonName,omitempty"`
- // ShowName: Default Show name, usually in the language of the country
- // of origin. Only available for TV Edits Example: "Googlers, The".
+ // ShowName: Default Show name,
+ // usually in the language of the country of origin.
+ // Only available for TV Edits
+ // Example: "Googlers, The".
ShowName string `json:"showName,omitempty"`
// Status: High-level status of the order.
//
// Possible values:
- // "STATUS_UNSPECIFIED"
- // "STATUS_APPROVED"
- // "STATUS_FAILED"
- // "STATUS_PROCESSING"
- // "STATUS_UNFULFILLED"
- // "STATUS_NOT_AVAILABLE"
+ // "STATUS_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "STATUS_APPROVED" - Approved by Google.
+ // "STATUS_FAILED" - Waiting for partner to re-deliver the asset after
+ // a rejection by Google.
+ // "STATUS_PROCESSING" - Waiting for Google to process the asset.
+ // "STATUS_UNFULFILLED" - Waiting for partner to deliver the asset.
+ // "STATUS_NOT_AVAILABLE" - Used when Status is not available (i.e:
+ // Orders for TV Seasons).
Status string `json:"status,omitempty"`
// StatusDetail: Detailed status of the order
//
// Possible values:
- // "ORDER_STATUS_UNSPECIFIED"
- // "ORDER_STATUS_QC_APPROVED"
- // "ORDER_STATUS_QC_REJECTION"
- // "ORDER_STATUS_INTERNAL_FIX"
- // "ORDER_STATUS_OPEN_ORDER"
- // "ORDER_STATUS_NOT_AVAILABLE"
- // "ORDER_STATUS_AWAITING_REDELIVERY"
- // "ORDER_STATUS_READY_FOR_QC"
- // "ORDER_STATUS_FILE_PROCESSING"
+ // "ORDER_STATUS_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "ORDER_STATUS_QC_APPROVED" - Approved by Google's Quality Control
+ // team.
+ // "ORDER_STATUS_QC_REJECTION" - Rejected by Google's Quality Control
+ // team, pending partner redelivery.
+ // "ORDER_STATUS_INTERNAL_FIX" - Internal error while processing the
+ // Order.
+ // "ORDER_STATUS_OPEN_ORDER" - Waiting for initial delivery from
+ // partner.
+ // "ORDER_STATUS_NOT_AVAILABLE" - Used on Orders that do not have
+ // Status, like TV Seasons.
+ // "ORDER_STATUS_AWAITING_REDELIVERY" - Waiting for re-delivery from
+ // partner.
+ // "ORDER_STATUS_READY_FOR_QC" - Asset was delivered by partner, but
+ // is being reviewed by Google's
+ // Quality Control team.
+ // "ORDER_STATUS_FILE_PROCESSING" - Waiting for Google to process the
+ // asset.
StatusDetail string `json:"statusDetail,omitempty"`
// StudioName: Name of the studio that owns the Edit ordered.
@@ -563,15 +665,20 @@
// Type: Type of the Edit linked to the Order.
//
// Possible values:
- // "TITLE_TYPE_UNSPECIFIED"
- // "MOVIE"
- // "SEASON"
- // "EPISODE"
- // "BUNDLE"
+ // "TITLE_TYPE_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "MOVIE" - A movie picture.
+ // "SEASON" - A season of a TV show.
+ // "EPISODE" - An episode of a TV show.
+ // "BUNDLE" - A collection of movies, i.e. "Googlers 1 and Googlers,
+ // the return"
Type string `json:"type,omitempty"`
// VideoId: Google-generated ID identifying the video linked to this
- // Order, once delivered. Example: 'gtry456_xc'.
+ // Order, once
+ // delivered.
+ // Example: 'gtry456_xc'.
VideoId string `json:"videoId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -616,24 +723,32 @@
}
// StoreInfo: Information about a playable sequence (video) associated
-// with an Edit and available at the Google Play Store. Internally, each
-// StoreInfo is uniquely identified by a `video_id` and `country`.
-// Externally, Title-level EIDR or Edit-level EIDR, if provided, can
-// also be used to identify a specific title or edit in a country.
+// with an Edit
+// and available at the Google Play Store.
+//
+// Internally, each StoreInfo is uniquely identified by a `video_id`
+// and `country`.
+//
+// Externally, Title-level EIDR or Edit-level EIDR, if provided,
+// can also be used to identify a specific title or edit in a country.
type StoreInfo struct {
// AudioTracks: Audio tracks available for this Edit.
AudioTracks []string `json:"audioTracks,omitempty"`
// Country: Country where Edit is available in ISO 3166-1 alpha-2
- // country code. Example: "US".
+ // country
+ // code.
+ // Example: "US".
Country string `json:"country,omitempty"`
- // EditLevelEidr: Edit-level EIDR ID. Example:
- // "10.5240/1489-49A2-3956-4B2D-FE16-6".
+ // EditLevelEidr: Edit-level EIDR ID.
+ // Example: "10.5240/1489-49A2-3956-4B2D-FE16-6".
EditLevelEidr string `json:"editLevelEidr,omitempty"`
- // EpisodeNumber: The number assigned to the episode within a season.
- // Only available on TV Edits. Example: "1".
+ // EpisodeNumber: The number assigned to the episode within a
+ // season.
+ // Only available on TV Edits.
+ // Example: "1".
EpisodeNumber string `json:"episodeNumber,omitempty"`
// HasAudio51: Whether the Edit has a 5.1 channel audio track.
@@ -657,39 +772,54 @@
// LiveTime: Timestamp when the Edit went live on the Store.
LiveTime string `json:"liveTime,omitempty"`
- // Mid: Knowledge Graph ID associated to this Edit, if available. This
- // ID links the Edit to its knowledge entity, externally accessible at
- // http://freebase.com. In the absense of Title EIDR or Edit EIDR, this
- // ID helps link together multiple Edits across countries. Example:
- // '/m/0ffx29'
+ // Mid: Knowledge Graph ID associated to this Edit, if available.
+ // This ID links the Edit to its knowledge entity, externally
+ // accessible
+ // at http://freebase.com.
+ // In the absense of Title EIDR or Edit EIDR, this ID helps link
+ // together
+ // multiple Edits across countries.
+ // Example: '/m/0ffx29'
Mid string `json:"mid,omitempty"`
- // Name: Default Edit name, usually in the language of the country of
- // origin. Example: "Googlers, The".
+ // Name: Default Edit name, usually in the language of the country
+ // of
+ // origin.
+ // Example: "Googlers, The".
Name string `json:"name,omitempty"`
// PphNames: Name of the post-production houses that manage the Edit.
PphNames []string `json:"pphNames,omitempty"`
// SeasonId: Google-generated ID identifying the season linked to the
- // Edit. Only available for TV Edits. Example: 'ster23ex'
+ // Edit.
+ // Only available for TV Edits.
+ // Example: 'ster23ex'
SeasonId string `json:"seasonId,omitempty"`
// SeasonName: Default Season name, usually in the language of the
- // country of origin. Only available for TV Edits Example: "Googlers,
- // The - A Brave New World".
+ // country of
+ // origin.
+ // Only available for TV Edits
+ // Example: "Googlers, The - A Brave New World".
SeasonName string `json:"seasonName,omitempty"`
- // SeasonNumber: The number assigned to the season within a show. Only
- // available on TV Edits. Example: "1".
+ // SeasonNumber: The number assigned to the season within a show.
+ // Only available on TV Edits.
+ // Example: "1".
SeasonNumber string `json:"seasonNumber,omitempty"`
- // ShowId: Google-generated ID identifying the show linked to the Edit.
- // Only available for TV Edits. Example: 'et2hsue_x'
+ // ShowId: Google-generated ID identifying the show linked to the
+ // Edit.
+ // Only available for TV Edits.
+ // Example: 'et2hsue_x'
ShowId string `json:"showId,omitempty"`
// ShowName: Default Show name, usually in the language of the country
- // of origin. Only available for TV Edits Example: "Googlers, The".
+ // of
+ // origin.
+ // Only available for TV Edits
+ // Example: "Googlers, The".
ShowName string `json:"showName,omitempty"`
// StudioName: Name of the studio that owns the Edit ordered.
@@ -698,26 +828,31 @@
// Subtitles: Subtitles available for this Edit.
Subtitles []string `json:"subtitles,omitempty"`
- // TitleLevelEidr: Title-level EIDR ID. Example:
- // "10.5240/1489-49A2-3956-4B2D-FE16-5".
+ // TitleLevelEidr: Title-level EIDR ID.
+ // Example: "10.5240/1489-49A2-3956-4B2D-FE16-5".
TitleLevelEidr string `json:"titleLevelEidr,omitempty"`
// TrailerId: Google-generated ID identifying the trailer linked to the
- // Edit. Example: 'bhd_4e_cx'
+ // Edit.
+ // Example: 'bhd_4e_cx'
TrailerId string `json:"trailerId,omitempty"`
// Type: Edit type, like Movie, Episode or Season.
//
// Possible values:
- // "TITLE_TYPE_UNSPECIFIED"
- // "MOVIE"
- // "SEASON"
- // "EPISODE"
- // "BUNDLE"
+ // "TITLE_TYPE_UNSPECIFIED" - Value could not be determined, please
+ // contact technical support if
+ // it should.
+ // "MOVIE" - A movie picture.
+ // "SEASON" - A season of a TV show.
+ // "EPISODE" - An episode of a TV show.
+ // "BUNDLE" - A collection of movies, i.e. "Googlers 1 and Googlers,
+ // the return"
Type string `json:"type,omitempty"`
// VideoId: Google-generated ID identifying the video linked to the
- // Edit. Example: 'gtry456_xc'
+ // Edit.
+ // Example: 'gtry456_xc'
VideoId string `json:"videoId,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -864,6 +999,7 @@
return ret, nil
// {
// "description": "Get an Avail given its avail group id and avail id.",
+ // "flatPath": "v1/accounts/{accountId}/avails/{availId}",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.avails.get",
// "parameterOrder": [
@@ -906,9 +1042,10 @@
header_ http.Header
}
-// List: List Avails owned or managed by the partner. See
-// _Authentication and Authorization rules_ and _List methods rules_ for
-// more information about this method.
+// List: List Avails owned or managed by the partner.
+//
+// See _Authentication and Authorization rules_ and
+// _List methods rules_ for more information about this method.
func (r *AccountsAvailsService) List(accountId string) *AccountsAvailsListCall {
c := &AccountsAvailsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.accountId = accountId
@@ -916,9 +1053,10 @@
}
// AltId sets the optional parameter "altId": Filter Avails that match a
-// case-insensitive, partner-specific custom id. NOTE: this field is
-// deprecated and will be removed on V2; `alt_ids` should be used
-// instead.
+// case-insensitive, partner-specific custom id.
+// NOTE: this field is deprecated and will be removed on V2;
+// `alt_ids`
+// should be used instead.
func (c *AccountsAvailsListCall) AltId(altId string) *AccountsAvailsListCall {
c.urlParams_.Set("altId", altId)
return c
@@ -960,17 +1098,19 @@
}
// Territories sets the optional parameter "territories": Filter Avails
-// that match (case-insensitive) any of the given country codes, using
-// the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").
+// that match (case-insensitive) any of the given country codes,
+// using the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").
func (c *AccountsAvailsListCall) Territories(territories ...string) *AccountsAvailsListCall {
c.urlParams_.SetMulti("territories", append([]string{}, territories...))
return c
}
// Title sets the optional parameter "title": Filter that matches Avails
-// with a `title_internal_alias`, `series_title_internal_alias`,
-// `season_title_internal_alias`, or `episode_title_internal_alias` that
-// contains the given case-insensitive title.
+// with a `title_internal_alias`,
+// `series_title_internal_alias`, `season_title_internal_alias`,
+// or `episode_title_internal_alias` that contains the
+// given
+// case-insensitive title.
func (c *AccountsAvailsListCall) Title(title string) *AccountsAvailsListCall {
c.urlParams_.Set("title", title)
return c
@@ -1078,7 +1218,8 @@
}
return ret, nil
// {
- // "description": "List Avails owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
+ // "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.",
+ // "flatPath": "v1/accounts/{accountId}/avails",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.avails.list",
// "parameterOrder": [
@@ -1092,7 +1233,7 @@
// "type": "string"
// },
// "altId": {
- // "description": "Filter Avails that match a case-insensitive, partner-specific custom id. NOTE: this field is deprecated and will be removed on V2; `alt_ids` should be used instead.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
@@ -1126,13 +1267,13 @@
// "type": "string"
// },
// "territories": {
- // "description": "Filter Avails that match (case-insensitive) any of the given country codes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
+ // "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\").",
// "location": "query",
// "repeated": true,
// "type": "string"
// },
// "title": {
- // "description": "Filter that matches Avails with a `title_internal_alias`, `series_title_internal_alias`, `season_title_internal_alias`, or `episode_title_internal_alias` that contains the given case-insensitive 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.",
// "location": "query",
// "type": "string"
// },
@@ -1187,9 +1328,10 @@
header_ http.Header
}
-// Get: Get an Order given its id. See _Authentication and Authorization
-// rules_ and _Get methods rules_ for more information about this
-// method.
+// Get: Get an Order given its id.
+//
+// See _Authentication and Authorization rules_ and
+// _Get methods rules_ for more information about this method.
func (r *AccountsOrdersService) Get(accountId string, orderId string) *AccountsOrdersGetCall {
c := &AccountsOrdersGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.accountId = accountId
@@ -1293,7 +1435,8 @@
}
return ret, nil
// {
- // "description": "Get an Order given its id. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.",
+ // "description": "Get an Order given its id.\n\nSee _Authentication and Authorization rules_ and\n_Get methods rules_ for more information about this method.",
+ // "flatPath": "v1/accounts/{accountId}/orders/{orderId}",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.orders.get",
// "parameterOrder": [
@@ -1336,9 +1479,10 @@
header_ http.Header
}
-// List: List Orders owned or managed by the partner. See
-// _Authentication and Authorization rules_ and _List methods rules_ for
-// more information about this method.
+// List: List Orders owned or managed by the partner.
+//
+// See _Authentication and Authorization rules_ and
+// _List methods rules_ for more information about this method.
func (r *AccountsOrdersService) List(accountId string) *AccountsOrdersListCall {
c := &AccountsOrdersListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.accountId = accountId
@@ -1353,8 +1497,8 @@
}
// Name sets the optional parameter "name": Filter that matches Orders
-// with a `name`, `show`, `season` or `episode` that contains the given
-// case-insensitive name.
+// with a `name`, `show`, `season` or `episode`
+// that contains the given case-insensitive name.
func (c *AccountsOrdersListCall) Name(name string) *AccountsOrdersListCall {
c.urlParams_.Set("name", name)
return c
@@ -1505,7 +1649,8 @@
}
return ret, nil
// {
- // "description": "List Orders owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
+ // "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.",
+ // "flatPath": "v1/accounts/{accountId}/orders",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.orders.list",
// "parameterOrder": [
@@ -1524,7 +1669,7 @@
// "type": "string"
// },
// "name": {
- // "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode` that contains the given case-insensitive name.",
+ // "description": "Filter that matches Orders with a `name`, `show`, `season` or `episode`\nthat contains the given case-insensitive name.",
// "location": "query",
// "type": "string"
// },
@@ -1615,9 +1760,10 @@
header_ http.Header
}
-// List: List StoreInfos owned or managed by the partner. See
-// _Authentication and Authorization rules_ and _List methods rules_ for
-// more information about this method.
+// List: List StoreInfos owned or managed by the partner.
+//
+// See _Authentication and Authorization rules_ and
+// _List methods rules_ for more information about this method.
func (r *AccountsStoreInfosService) List(accountId string) *AccountsStoreInfosListCall {
c := &AccountsStoreInfosListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.accountId = accountId
@@ -1625,8 +1771,9 @@
}
// Countries sets the optional parameter "countries": Filter StoreInfos
-// that match (case-insensitive) any of the given country codes, using
-// the "ISO 3166-1 alpha-2" format (examples: "US", "us", "Us").
+// that match (case-insensitive) any of the given country
+// codes, using the "ISO 3166-1 alpha-2" format (examples: "US", "us",
+// "Us").
func (c *AccountsStoreInfosListCall) Countries(countries ...string) *AccountsStoreInfosListCall {
c.urlParams_.SetMulti("countries", append([]string{}, countries...))
return c
@@ -1640,8 +1787,8 @@
}
// Name sets the optional parameter "name": Filter that matches
-// StoreInfos with a `name` or `show_name` that contains the given
-// case-insensitive name.
+// StoreInfos with a `name` or `show_name`
+// that contains the given case-insensitive name.
func (c *AccountsStoreInfosListCall) Name(name string) *AccountsStoreInfosListCall {
c.urlParams_.Set("name", name)
return c
@@ -1683,8 +1830,10 @@
}
// VideoId sets the optional parameter "videoId": Filter StoreInfos that
-// match a given `video_id`. NOTE: this field is deprecated and will be
-// removed on V2; `video_ids` should be used instead.
+// match a given `video_id`.
+// NOTE: this field is deprecated and will be removed on V2;
+// `video_ids`
+// should be used instead.
func (c *AccountsStoreInfosListCall) VideoId(videoId string) *AccountsStoreInfosListCall {
c.urlParams_.Set("videoId", videoId)
return c
@@ -1792,7 +1941,8 @@
}
return ret, nil
// {
- // "description": "List StoreInfos owned or managed by the partner. See _Authentication and Authorization rules_ and _List methods rules_ for more information about this method.",
+ // "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.",
+ // "flatPath": "v1/accounts/{accountId}/storeInfos",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.storeInfos.list",
// "parameterOrder": [
@@ -1806,7 +1956,7 @@
// "type": "string"
// },
// "countries": {
- // "description": "Filter StoreInfos that match (case-insensitive) any of the given country codes, using the \"ISO 3166-1 alpha-2\" format (examples: \"US\", \"us\", \"Us\").",
+ // "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\").",
// "location": "query",
// "repeated": true,
// "type": "string"
@@ -1818,7 +1968,7 @@
// "type": "string"
// },
// "name": {
- // "description": "Filter that matches StoreInfos with a `name` or `show_name` that contains the given case-insensitive name.",
+ // "description": "Filter that matches StoreInfos with a `name` or `show_name`\nthat contains the given case-insensitive name.",
// "location": "query",
// "type": "string"
// },
@@ -1852,7 +2002,7 @@
// "type": "string"
// },
// "videoId": {
- // "description": "Filter StoreInfos that match a given `video_id`. NOTE: this field is deprecated and will be removed on V2; `video_ids` should be used instead.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
@@ -1908,9 +2058,10 @@
header_ http.Header
}
-// Get: Get a StoreInfo given its video id and country. See
-// _Authentication and Authorization rules_ and _Get methods rules_ for
-// more information about this method.
+// Get: Get a StoreInfo given its video id and country.
+//
+// See _Authentication and Authorization rules_ and
+// _Get methods rules_ for more information about this method.
func (r *AccountsStoreInfosCountryService) Get(accountId string, videoId string, country string) *AccountsStoreInfosCountryGetCall {
c := &AccountsStoreInfosCountryGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.accountId = accountId
@@ -2016,7 +2167,8 @@
}
return ret, nil
// {
- // "description": "Get a StoreInfo given its video id and country. See _Authentication and Authorization rules_ and _Get methods rules_ for more information about this method.",
+ // "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.",
+ // "flatPath": "v1/accounts/{accountId}/storeInfos/{videoId}/country/{country}",
// "httpMethod": "GET",
// "id": "playmoviespartner.accounts.storeInfos.country.get",
// "parameterOrder": [
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json
index a459f52..6277fc0 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-api.json
+++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,1053 +1,1146 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"jQLIOHBVnDZie4rQHGH1WJF-INE/InJfaYgEs4kvxVpfe1cZDPrjhv0\"",
- "discoveryVersion": "v1",
- "id": "proximitybeacon:v1beta1",
- "name": "proximitybeacon",
- "version": "v1beta1",
- "revision": "20160429",
- "title": "Google Proximity Beacon API",
- "description": "Registers, manages, indexes, and searches beacons.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/beacons/proximity/",
- "protocol": "rest",
- "baseUrl": "https://proximitybeacon.googleapis.com/",
- "basePath": "",
- "rootUrl": "https://proximitybeacon.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "version_module": true,
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "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.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/userlocation.beacon.registry": {
- "description": "View and modify your beacons"
+ "id": "proximitybeacon:v1beta1",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/userlocation.beacon.registry": {
+ "description": "View and modify your beacons"
+ }
+ }
}
- }
- }
- },
- "schemas": {
- "Beacon": {
- "id": "Beacon",
- "type": "object",
- "description": "Details of a beacon device.",
- "properties": {
- "beaconName": {
- "type": "string",
- "description": "Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations."
- },
- "advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a \"stable\" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon."
- },
- "status": {
- "type": "string",
- "description": "Current status of the beacon. Required.",
- "enum": [
- "STATUS_UNSPECIFIED",
- "ACTIVE",
- "DECOMMISSIONED",
- "INACTIVE"
- ]
- },
- "placeId": {
- "type": "string",
- "description": "The [Google Places API](/places/place-id) Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional."
- },
- "latLng": {
- "$ref": "LatLng",
- "description": "The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional."
- },
- "indoorLevel": {
- "$ref": "IndoorLevel",
- "description": "The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional."
- },
- "expectedStability": {
- "type": "string",
- "description": "Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.",
- "enum": [
- "STABILITY_UNSPECIFIED",
- "STABLE",
- "PORTABLE",
- "MOBILE",
- "ROVING"
- ]
- },
- "description": {
- "type": "string",
- "description": "Free text used to identify and describe the beacon. Maximum length 140 characters. Optional."
- },
- "properties": {
- "type": "object",
- "description": "Properties of the beacon device, for example battery type or firmware version. Optional.",
- "additionalProperties": {
- "type": "string"
- }
- },
- "ephemeralIdRegistration": {
- "$ref": "EphemeralIdRegistration",
- "description": "Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error."
- },
- "provisioningKey": {
- "type": "string",
- "description": "Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.",
- "format": "byte"
- }
- }
},
- "AdvertisedId": {
- "id": "AdvertisedId",
- "type": "object",
- "description": "Defines a unique identifier of a beacon as broadcast by the device.",
- "properties": {
- "type": {
- "type": "string",
- "description": "Specifies the identifier type. Required.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "EDDYSTONE",
- "IBEACON",
- "ALTBEACON",
- "EDDYSTONE_EID"
- ]
+ "description": "Registers, manages, indexes, and searches beacons.",
+ "protocol": "rest",
+ "title": "Google Proximity Beacon API",
+ "resources": {
+ "v1beta1": {
+ "methods": {
+ "getEidparams": {
+ "id": "proximitybeacon.getEidparams",
+ "response": {
+ "$ref": "EphemeralIdRegistrationParams"
+ },
+ "parameterOrder": [],
+ "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.",
+ "flatPath": "v1beta1/eidparams",
+ "httpMethod": "GET",
+ "parameters": {},
+ "path": "v1beta1/eidparams",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ }
+ }
},
- "id": {
- "type": "string",
- "description": "The actual beacon identifier, as broadcast by the beacon hardware. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.",
- "format": "byte"
- }
- }
- },
- "LatLng": {
- "id": "LatLng",
- "type": "object",
- "description": "An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Example of normalization code in Python: def NormalizeLongitude(longitude): \"\"\"Wraps decimal degrees longitude to [-180.0, 180.0].\"\"\" q, r = divmod(longitude, 360.0) if r \u003e 180.0 or (r == 180.0 and q \u003c= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): \"\"\"Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.\"\"\" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)",
- "properties": {
- "latitude": {
- "type": "number",
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
- "format": "double"
- },
- "longitude": {
- "type": "number",
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
- "format": "double"
- }
- }
- },
- "IndoorLevel": {
- "id": "IndoorLevel",
- "type": "object",
- "description": "Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on.",
- "properties": {
- "name": {
- "type": "string",
- "description": "The name of this level."
- }
- }
- },
- "EphemeralIdRegistration": {
- "id": "EphemeralIdRegistration",
- "type": "object",
- "description": "Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "properties": {
- "beaconEcdhPublicKey": {
- "type": "string",
- "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.",
- "format": "byte"
- },
- "serviceEcdhPublicKey": {
- "type": "string",
- "description": "The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.",
- "format": "byte"
- },
- "beaconIdentityKey": {
- "type": "string",
- "description": "The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.",
- "format": "byte"
- },
- "rotationPeriodExponent": {
- "type": "integer",
- "description": "Indicates the nominal period between each rotation of the beacon's ephemeral ID. \"Nominal\" because the beacon should randomize the actual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid) for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.",
- "format": "uint32"
- },
- "initialClockValue": {
- "type": "string",
- "description": "The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.",
- "format": "uint64"
- },
- "initialEid": {
- "type": "string",
- "description": "An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.",
- "format": "byte"
- }
- }
- },
- "Empty": {
- "id": "Empty",
- "type": "object",
- "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
- },
- "ListBeaconsResponse": {
- "id": "ListBeaconsResponse",
- "type": "object",
- "description": "Response that contains list beacon results and pagination help.",
- "properties": {
"beacons": {
- "type": "array",
- "description": "The beacons that matched the search criteria.",
- "items": {
- "$ref": "Beacon"
- }
+ "resources": {
+ "attachments": {
+ "methods": {
+ "create": {
+ "id": "proximitybeacon.beacons.attachments.create",
+ "response": {
+ "$ref": "BeaconAttachment"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "request": {
+ "$ref": "BeaconAttachment"
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}/attachments",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "list": {
+ "id": "proximitybeacon.beacons.attachments.list",
+ "response": {
+ "$ref": "ListBeaconAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
+ "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\".",
+ "location": "query",
+ "type": "string"
+ },
+ "beaconName": {
+ "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}/attachments",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "batchDelete": {
+ "id": "proximitybeacon.beacons.attachments.batchDelete",
+ "response": {
+ "$ref": "DeleteAttachmentsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
+ "httpMethod": "POST",
+ "parameters": {
+ "namespacedType": {
+ "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.",
+ "location": "query",
+ "type": "string"
+ },
+ "beaconName": {
+ "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}/attachments:batchDelete",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "delete": {
+ "id": "proximitybeacon.beacons.attachments.delete",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
+ "httpMethod": "DELETE",
+ "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.",
+ "required": true,
+ "pattern": "^beacons/[^/]+/attachments/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+attachmentName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ }
+ }
+ },
+ "diagnostics": {
+ "methods": {
+ "list": {
+ "id": "proximitybeacon.beacons.diagnostics.list",
+ "response": {
+ "$ref": "ListDiagnosticsResponse"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
+ "httpMethod": "GET",
+ "parameters": {
+ "pageSize": {
+ "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
+ "location": "query",
+ "type": "integer",
+ "format": "int32"
+ },
+ "alertFilter": {
+ "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "beaconName": {
+ "description": "Beacon that the diagnostics are for.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
+ "location": "query",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}/diagnostics",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ }
+ }
+ }
+ },
+ "methods": {
+ "decommission": {
+ "id": "proximitybeacon.beacons.decommission",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}:decommission",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "activate": {
+ "id": "proximitybeacon.beacons.activate",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}:activate",
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}:activate",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "deactivate": {
+ "id": "proximitybeacon.beacons.deactivate",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
+ "httpMethod": "POST",
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}:deactivate",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "list": {
+ "id": "proximitybeacon.beacons.list",
+ "response": {
+ "$ref": "ListBeaconsResponse"
+ },
+ "parameterOrder": [],
+ "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.",
+ "flatPath": "v1beta1/beacons",
+ "httpMethod": "GET",
+ "parameters": {
+ "q": {
+ "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
+ "location": "query",
+ "type": "integer",
+ "format": "int32"
+ },
+ "pageToken": {
+ "description": "A pagination token obtained from a previous request to list beacons.",
+ "location": "query",
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/beacons",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "get": {
+ "id": "proximitybeacon.beacons.get",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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.",
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "httpMethod": "GET",
+ "parameters": {
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "update": {
+ "id": "proximitybeacon.beacons.update",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "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"
+ },
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "httpMethod": "PUT",
+ "parameters": {
+ "beaconName": {
+ "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "register": {
+ "id": "proximitybeacon.beacons.register",
+ "response": {
+ "$ref": "Beacon"
+ },
+ "parameterOrder": [],
+ "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"
+ },
+ "flatPath": "v1beta1/beacons:register",
+ "httpMethod": "POST",
+ "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.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/beacons:register",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ },
+ "delete": {
+ "id": "proximitybeacon.beacons.delete",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "beaconName"
+ ],
+ "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.",
+ "flatPath": "v1beta1/beacons/{beaconsId}",
+ "httpMethod": "DELETE",
+ "parameters": {
+ "beaconName": {
+ "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ "required": true,
+ "pattern": "^beacons/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+beaconName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
+ }
+ }
},
- "nextPageToken": {
- "type": "string",
- "description": "An opaque pagination token that the client may provide in their next request to retrieve the next page of results."
+ "beaconinfo": {
+ "methods": {
+ "getforobserved": {
+ "id": "proximitybeacon.beaconinfo.getforobserved",
+ "response": {
+ "$ref": "GetInfoForObservedBeaconsResponse"
+ },
+ "parameterOrder": [],
+ "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/how-tos/authorizing#APIKey)\nfor the application.",
+ "request": {
+ "$ref": "GetInfoForObservedBeaconsRequest"
+ },
+ "flatPath": "v1beta1/beaconinfo:getforobserved",
+ "httpMethod": "POST",
+ "parameters": {},
+ "path": "v1beta1/beaconinfo:getforobserved"
+ }
+ }
},
- "totalCount": {
- "type": "string",
- "description": "Estimate of the total number of beacons matched by the query. Higher values may be less accurate.",
- "format": "int64"
- }
- }
- },
- "BeaconAttachment": {
- "id": "BeaconAttachment",
- "type": "object",
- "description": "Project-specific data associated with a beacon.",
- "properties": {
- "attachmentName": {
- "type": "string",
- "description": "Resource name of this attachment. Attachment names have the format: beacons/beacon_id/attachments/attachment_id. Leave this empty on creation."
- },
- "namespacedType": {
- "type": "string",
- "description": "Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required."
- },
- "data": {
- "type": "string",
- "description": "An opaque data container for client-provided data. Must be [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.",
- "format": "byte"
- }
- }
- },
- "ListBeaconAttachmentsResponse": {
- "id": "ListBeaconAttachmentsResponse",
- "type": "object",
- "description": "Response to ListBeaconAttachments that contains the requested attachments.",
- "properties": {
- "attachments": {
- "type": "array",
- "description": "The attachments that corresponded to the request params.",
- "items": {
- "$ref": "BeaconAttachment"
- }
- }
- }
- },
- "DeleteAttachmentsResponse": {
- "id": "DeleteAttachmentsResponse",
- "type": "object",
- "description": "Response for a request to delete attachments.",
- "properties": {
- "numDeleted": {
- "type": "integer",
- "description": "The number of attachments that were deleted.",
- "format": "int32"
- }
- }
- },
- "ListNamespacesResponse": {
- "id": "ListNamespacesResponse",
- "type": "object",
- "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
- "properties": {
"namespaces": {
- "type": "array",
- "description": "The attachments that corresponded to the request params.",
- "items": {
- "$ref": "Namespace"
- }
- }
- }
- },
- "Namespace": {
- "id": "Namespace",
- "type": "object",
- "description": "An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.",
- "properties": {
- "namespaceName": {
- "type": "string",
- "description": "Resource name of this namespace. Namespaces names have the format: namespaces/namespace."
- },
- "servingVisibility": {
- "type": "string",
- "description": "Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.",
- "enum": [
- "VISIBILITY_UNSPECIFIED",
- "UNLISTED",
- "PUBLIC"
- ]
- }
- }
- },
- "EphemeralIdRegistrationParams": {
- "id": "EphemeralIdRegistrationParams",
- "type": "object",
- "description": "Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
- "properties": {
- "serviceEcdhPublicKey": {
- "type": "string",
- "description": "The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.",
- "format": "byte"
- },
- "minRotationPeriodExponent": {
- "type": "integer",
- "description": "Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32"
- },
- "maxRotationPeriodExponent": {
- "type": "integer",
- "description": "Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent",
- "format": "uint32"
- }
- }
- },
- "ListDiagnosticsResponse": {
- "id": "ListDiagnosticsResponse",
- "type": "object",
- "description": "Response that contains the requested diagnostics.",
- "properties": {
- "diagnostics": {
- "type": "array",
- "description": "The diagnostics matching the given request.",
- "items": {
- "$ref": "Diagnostics"
- }
- },
- "nextPageToken": {
- "type": "string",
- "description": "Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response."
- }
- }
- },
- "Diagnostics": {
- "id": "Diagnostics",
- "type": "object",
- "description": "Diagnostics for a single beacon.",
- "properties": {
- "beaconName": {
- "type": "string",
- "description": "Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's \"stable\" Eddystone-UID."
- },
- "estimatedLowBatteryDate": {
- "$ref": "Date",
- "description": "The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date."
- },
- "alerts": {
- "type": "array",
- "description": "An unordered list of Alerts that the beacon has.",
- "enumDescriptions": [
- "Invalid value. Should never appear.",
- "The beacon has been reported in a location different than its registered location. This may indicate that the beacon has been moved. This signal is not 100% accurate, but indicates that further investigation is worth while.",
- "The battery level for the beacon is low enough that, given the beacon's current use, its battery will run out with in the next 60 days. This indicates that the battery should be replaced soon."
- ],
- "items": {
- "type": "string",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY"
- ]
- }
- }
- }
- },
- "Date": {
- "id": "Date",
- "type": "object",
- "description": "Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
- "properties": {
- "year": {
- "type": "integer",
- "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.",
- "format": "int32"
- },
- "month": {
- "type": "integer",
- "description": "Month of year. Must be from 1 to 12.",
- "format": "int32"
- },
- "day": {
- "type": "integer",
- "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.",
- "format": "int32"
- }
- }
- },
- "GetInfoForObservedBeaconsRequest": {
- "id": "GetInfoForObservedBeaconsRequest",
- "type": "object",
- "description": "Request for beacon and attachment information about beacons that a mobile client has encountered \"in the wild\".",
- "properties": {
- "observations": {
- "type": "array",
- "description": "The beacons that the client has encountered. At least one must be given.",
- "items": {
- "$ref": "Observation"
- }
- },
- "namespacedTypes": {
- "type": "array",
- "description": "Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format namespace/type. Accepts `*` to specify all types in all namespaces. Optional.",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Observation": {
- "id": "Observation",
- "type": "object",
- "description": "Represents one beacon observed once.",
- "properties": {
- "advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon the client has encountered. Clients may submit an Eddystone-EID `advertised_id`. If the client is not authorized to resolve the given Eddystone-EID, no data will be returned for that beacon. Required."
- },
- "telemetry": {
- "type": "string",
- "description": "The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.",
- "format": "byte"
- },
- "timestampMs": {
- "type": "string",
- "description": "Time when the beacon was observed."
- }
- }
- },
- "GetInfoForObservedBeaconsResponse": {
- "id": "GetInfoForObservedBeaconsResponse",
- "type": "object",
- "description": "Information about the requested beacons, optionally including attachment data.",
- "properties": {
- "beacons": {
- "type": "array",
- "description": "Public information about beacons. May be empty if the request matched no beacons.",
- "items": {
- "$ref": "BeaconInfo"
- }
- }
- }
- },
- "BeaconInfo": {
- "id": "BeaconInfo",
- "type": "object",
- "description": "A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.",
- "properties": {
- "advertisedId": {
- "$ref": "AdvertisedId",
- "description": "The ID advertised by the beacon."
- },
- "beaconName": {
- "type": "string",
- "description": "The name under which the beacon is registered."
- },
- "attachments": {
- "type": "array",
- "description": "Attachments matching the type(s) requested. May be empty if no attachment types were requested, or if none matched.",
- "items": {
- "$ref": "AttachmentInfo"
- }
- }
- }
- },
- "AttachmentInfo": {
- "id": "AttachmentInfo",
- "type": "object",
- "description": "A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.",
- "properties": {
- "namespacedType": {
- "type": "string",
- "description": "Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type, for example scrupulous-wombat-12345/welcome-message"
- },
- "data": {
- "type": "string",
- "description": "An opaque data container for client-provided data.",
- "format": "byte"
- }
- }
- }
- },
- "resources": {
- "beacons": {
- "methods": {
- "register": {
- "id": "proximitybeacon.beacons.register",
- "path": "v1beta1/beacons:register",
- "httpMethod": "POST",
- "description": "Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.",
- "location": "query"
- }
- },
- "request": {
- "$ref": "Beacon"
- },
- "response": {
- "$ref": "Beacon"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "decommission": {
- "id": "proximitybeacon.beacons.decommission",
- "path": "v1beta1/{+beaconName}:decommission",
- "httpMethod": "POST",
- "description": "Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Beacon that should be decommissioned. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "get": {
- "id": "proximitybeacon.beacons.get",
- "path": "v1beta1/{+beaconName}",
- "httpMethod": "GET",
- "description": "Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Beacon"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "list": {
- "id": "proximitybeacon.beacons.list",
- "path": "v1beta1/beacons",
- "httpMethod": "GET",
- "description": "Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "q": {
- "type": "string",
- "description": "Filter query string that supports the following field filters: * `description:\"\"` For example: `description:\"Room 3\"` Returns beacons whose description matches tokens in the string \"Room 3\" (not necessarily that exact string). The string must be double-quoted. * `status:` For example: `status:active` Returns beacons whose status matches the given value. Values must be one of the Beacon.Status enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `stability:` For example: `stability:mobile` Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `place_id:\"\"` For example: `place_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"` Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from [Google Places API](/places/place-id). Does not match places inside the given place. Does not consider the beacon's actual location (which may be different from its registered place). Accepts multiple filters that will be combined with OR logic. The place ID must be double-quoted. * `registration_time[|=]` For example: `registration_time\u003e=1433116800` Returns beacons whose registration time matches the given filter. Supports the operators: , =. Timestamp must be expressed as an integer number of seconds since midnight January 1, 1970 UTC. Accepts at most two filters that will be combined with AND logic, to support \"between\" semantics. If more than two are supplied, the latter ones are ignored. * `lat: lng: radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000` Returns beacons whose registered location is within the given circle. When any of these fields are given, all are required. Latitude and longitude must be decimal degrees between -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an integer number of meters between 10 and 1,000,000 (1000 km). * `property:\"=\"` For example: `property:\"battery-type=CR2032\"` Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string. * `attachment_type:\"\"` For example: `attachment_type:\"my-namespace/my-type\"` Returns beacons having at least one attachment of the given namespaced type. Supports \"any within this namespace\" via the partial wildcard syntax: \"my-namespace/*\". Supports multiple filters which will be combined with OR logic. The string must be double-quoted. Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "A pagination token obtained from a previous request to list beacons.",
- "location": "query"
- },
- "pageSize": {
- "type": "integer",
- "description": "The maximum number of records to return for this request, up to a server-defined upper limit.",
- "format": "int32",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListBeaconsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "update": {
- "id": "proximitybeacon.beacons.update",
- "path": "v1beta1/{+beaconName}",
- "httpMethod": "PUT",
- "description": "Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the \"read, modify, write\" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "request": {
- "$ref": "Beacon"
- },
- "response": {
- "$ref": "Beacon"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "activate": {
- "id": "proximitybeacon.beacons.activate",
- "path": "v1beta1/{+beaconName}:activate",
- "httpMethod": "POST",
- "description": "Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Beacon that should be activated. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "deactivate": {
- "id": "proximitybeacon.beacons.deactivate",
- "path": "v1beta1/{+beaconName}:deactivate",
- "httpMethod": "POST",
- "description": "Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Beacon that should be deactivated. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "projectId": {
- "type": "string",
- "description": "The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- }
- },
- "resources": {
- "attachments": {
- "methods": {
- "create": {
- "id": "proximitybeacon.beacons.attachments.create",
- "path": "v1beta1/{+beaconName}/attachments",
- "httpMethod": "POST",
- "description": "Associates the given data with the specified beacon. Attachment data must contain two parts: \n- A namespaced type. \n- The actual attachment data itself. The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Beacon on which the attachment should be created. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
+ "methods": {
+ "update": {
+ "id": "proximitybeacon.namespaces.update",
+ "response": {
+ "$ref": "Namespace"
+ },
+ "parameterOrder": [
+ "namespaceName"
+ ],
+ "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
+ "request": {
+ "$ref": "Namespace"
+ },
+ "flatPath": "v1beta1/namespaces/{namespacesId}",
+ "httpMethod": "PUT",
+ "parameters": {
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "required": true,
+ "pattern": "^namespaces/[^/]+$",
+ "location": "path",
+ "type": "string"
+ },
+ "projectId": {
+ "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/{+namespaceName}",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
},
- "projectId": {
- "type": "string",
- "description": "The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.",
- "location": "query"
+ "list": {
+ "id": "proximitybeacon.namespaces.list",
+ "response": {
+ "$ref": "ListNamespacesResponse"
+ },
+ "parameterOrder": [],
+ "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.",
+ "flatPath": "v1beta1/namespaces",
+ "httpMethod": "GET",
+ "parameters": {
+ "projectId": {
+ "description": "The project id to list namespaces under.\nOptional.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1beta1/namespaces",
+ "scopes": [
+ "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ ]
}
- },
- "parameterOrder": [
- "beaconName"
- ],
- "request": {
- "$ref": "BeaconAttachment"
- },
- "response": {
- "$ref": "BeaconAttachment"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
+ }
+ }
+ },
+ "schemas": {
+ "ListBeaconsResponse": {
+ "description": "Response that contains list beacon results and pagination help.",
+ "type": "object",
+ "properties": {
+ "beacons": {
+ "description": "The beacons that matched the search criteria.",
+ "type": "array",
+ "items": {
+ "$ref": "Beacon"
+ }
+ },
+ "nextPageToken": {
+ "description": "An opaque pagination token that the client may provide in their next\nrequest to retrieve the next page of results.",
+ "type": "string"
+ },
+ "totalCount": {
+ "description": "Estimate of the total number of beacons matched by the query. Higher\nvalues may be less accurate.",
+ "type": "string",
+ "format": "int64"
+ }
},
- "list": {
- "id": "proximitybeacon.beacons.attachments.list",
- "path": "v1beta1/{+beaconName}/attachments",
- "httpMethod": "GET",
- "description": "Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
+ "id": "ListBeaconsResponse"
+ },
+ "Observation": {
+ "description": "Represents one beacon observed once.",
+ "type": "object",
+ "properties": {
+ "advertisedId": {
+ "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired.",
+ "$ref": "AdvertisedId"
+ },
+ "telemetry": {
+ "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.",
+ "type": "string",
+ "format": "byte"
+ },
+ "timestampMs": {
+ "description": "Time when the beacon was observed.",
+ "type": "string",
+ "format": "google-datetime"
+ }
+ },
+ "id": "Observation"
+ },
+ "Diagnostics": {
+ "description": "Diagnostics for a single beacon.",
+ "type": "object",
+ "properties": {
+ "alerts": {
+ "description": "An unordered list of Alerts that the beacon has.",
+ "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."
+ ],
+ "type": "array",
+ "items": {
+ "enum": [
+ "ALERT_UNSPECIFIED",
+ "WRONG_LOCATION",
+ "LOW_BATTERY"
+ ],
+ "type": "string"
+ }
+ },
"beaconName": {
- "type": "string",
- "description": "Beacon whose attachments should be fetched. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
+ "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"
+ },
+ "estimatedLowBatteryDate": {
+ "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date.",
+ "$ref": "Date"
+ }
+ },
+ "id": "Diagnostics"
+ },
+ "AdvertisedId": {
+ "description": "Defines a unique identifier of a beacon as broadcast by the device.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Specifies the identifier type.\nRequired.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "EDDYSTONE",
+ "IBEACON",
+ "ALTBEACON",
+ "EDDYSTONE_EID"
+ ],
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Eddystone, an open beacon format that supports Android and iOS devices\nhttps://github.com/google/eddystone/wiki/Beacon-Specification",
+ "Apple iBeacon compatible beacon",
+ "See http://altbeacon.org and/or https://github.com/AltBeacon/spec.",
+ "Eddystone Ephemeral ID"
+ ],
+ "type": "string"
+ },
+ "id": {
+ "description": "The actual beacon identifier, as broadcast by the beacon hardware. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses. The base64\nencoding should be of the binary byte-stream and not any textual (such as\nhex) representation thereof.\nRequired.",
+ "type": "string",
+ "format": "byte"
+ }
+ },
+ "id": "AdvertisedId"
+ },
+ "DeleteAttachmentsResponse": {
+ "description": "Response for a request to delete attachments.",
+ "type": "object",
+ "properties": {
+ "numDeleted": {
+ "description": "The number of attachments that were deleted.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "id": "DeleteAttachmentsResponse"
+ },
+ "EphemeralIdRegistration": {
+ "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object",
+ "properties": {
+ "beaconEcdhPublicKey": {
+ "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "type": "string",
+ "format": "byte"
+ },
+ "initialClockValue": {
+ "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.",
+ "type": "string",
+ "format": "uint64"
+ },
+ "beaconIdentityKey": {
+ "description": "The private key of the beacon. If this field is populated,\n`beacon_ecdh_public_key` and `service_ecdh_public_key` must not be\npopulated.",
+ "type": "string",
+ "format": "byte"
+ },
+ "serviceEcdhPublicKey": {
+ "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.",
+ "type": "string",
+ "format": "byte"
+ },
+ "rotationPeriodExponent": {
+ "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "initialEid": {
+ "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",
+ "format": "byte"
+ }
+ },
+ "id": "EphemeralIdRegistration"
+ },
+ "ListDiagnosticsResponse": {
+ "description": "Response that contains the requested diagnostics.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.",
+ "type": "string"
+ },
+ "diagnostics": {
+ "description": "The diagnostics matching the given request.",
+ "type": "array",
+ "items": {
+ "$ref": "Diagnostics"
+ }
+ }
+ },
+ "id": "ListDiagnosticsResponse"
+ },
+ "BeaconInfo": {
+ "description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.",
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "description": "Attachments matching the type(s) requested.\nMay be empty if no attachment types were requested.",
+ "type": "array",
+ "items": {
+ "$ref": "AttachmentInfo"
+ }
+ },
+ "beaconName": {
+ "description": "The name under which the beacon is registered.",
+ "type": "string"
+ },
+ "advertisedId": {
+ "description": "The ID advertised by the beacon.",
+ "$ref": "AdvertisedId"
+ }
+ },
+ "id": "BeaconInfo"
+ },
+ "IndoorLevel": {
+ "description": "Indoor level, a human-readable string as returned by Google Maps APIs,\nuseful to indicate which floor of a building a beacon is located on.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of this level.",
+ "type": "string"
+ }
+ },
+ "id": "IndoorLevel"
+ },
+ "EphemeralIdRegistrationParams": {
+ "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.",
+ "type": "object",
+ "properties": {
+ "serviceEcdhPublicKey": {
+ "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.",
+ "type": "string",
+ "format": "byte"
+ },
+ "minRotationPeriodExponent": {
+ "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "type": "integer",
+ "format": "uint32"
+ },
+ "maxRotationPeriodExponent": {
+ "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent",
+ "type": "integer",
+ "format": "uint32"
+ }
+ },
+ "id": "EphemeralIdRegistrationParams"
+ },
+ "ListBeaconAttachmentsResponse": {
+ "description": "Response to `ListBeaconAttachments` that contains the requested attachments.",
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "description": "The attachments that corresponded to the request params.",
+ "type": "array",
+ "items": {
+ "$ref": "BeaconAttachment"
+ }
+ }
+ },
+ "id": "ListBeaconAttachmentsResponse"
+ },
+ "Namespace": {
+ "description": "An attachment namespace defines read and write access for all the attachments\ncreated under it. Each namespace is globally unique, and owned by one\nproject which is the only project that can create attachments under it.",
+ "type": "object",
+ "properties": {
+ "namespaceName": {
+ "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
+ "type": "string"
+ },
+ "servingVisibility": {
+ "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.",
+ "enum": [
+ "VISIBILITY_UNSPECIFIED",
+ "UNLISTED",
+ "PUBLIC"
+ ],
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Served only to the project that owns the namespace.",
+ "Any project can subscribe to attachments under the namespace."
+ ],
+ "type": "string"
+ }
+ },
+ "id": "Namespace"
+ },
+ "AttachmentInfo": {
+ "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "An opaque data container for client-provided data.",
+ "type": "string",
+ "format": "byte"
},
"namespacedType": {
- "type": "string",
- "description": "Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify \"all types in all namespaces\".",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "The project id to list beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If \"*\" is specified and the projectId string is empty, then the project making the request is used. Optional.",
- "location": "query"
+ "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"
}
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "ListBeaconAttachmentsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
},
- "delete": {
- "id": "proximitybeacon.beacons.attachments.delete",
- "path": "v1beta1/{+attachmentName}",
- "httpMethod": "DELETE",
- "description": "Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
+ "id": "AttachmentInfo"
+ },
+ "Beacon": {
+ "description": "Details of a beacon device.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.",
+ "type": "string"
+ },
+ "provisioningKey": {
+ "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.",
+ "type": "string",
+ "format": "byte"
+ },
+ "status": {
+ "description": "Current status of the beacon.\nRequired.",
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "ACTIVE",
+ "DECOMMISSIONED",
+ "INACTIVE"
+ ],
+ "enumDescriptions": [
+ "Do not use this value.",
+ "The \"normal\" in-use state of a beacon.",
+ "Beacon should no longer be used for any purpose. This is irreversible.",
+ "The beacon should not be visible to mobile devices. This is reversible."
+ ],
+ "type": "string"
+ },
+ "properties": {
+ "description": "Properties of the beacon device, for example battery type or firmware\nversion.\nOptional.",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "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"
+ },
+ "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"
+ },
+ "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"
+ },
+ "latLng": {
+ "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional.",
+ "$ref": "LatLng"
+ },
+ "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.",
+ "enum": [
+ "STABILITY_UNSPECIFIED",
+ "STABLE",
+ "PORTABLE",
+ "MOBILE",
+ "ROVING"
+ ],
+ "enumDescriptions": [
+ "Do not use this value.",
+ "Not expected to move, for example a store's front door.",
+ "Usually stable but may move rarely, usually within a single place,\nfor example a store display.",
+ "Moves frequently, for example a personal item or food truck.",
+ "Moves continuously in service, for example a bus or train."
+ ],
+ "type": "string"
+ },
+ "indoorLevel": {
+ "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.",
+ "$ref": "IndoorLevel"
+ }
+ },
+ "id": "Beacon"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object",
+ "properties": {},
+ "id": "Empty"
+ },
+ "BeaconAttachment": {
+ "description": "Project-specific data associated with a beacon.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.",
+ "type": "string",
+ "format": "byte"
+ },
+ "namespacedType": {
+ "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e. Namespace\nprovides type separation between clients. Type describes the type of\n`data`, for use by the client when parsing the `data` field.\nRequired.",
+ "type": "string"
+ },
"attachmentName": {
- "type": "string",
- "description": "The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its \"stable\" Eddystone-UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*/attachments/[^/]*$",
- "location": "path"
+ "description": "Resource name of this attachment. Attachment names have the format:\n\u003ccode\u003ebeacons/\u003cvar\u003ebeacon_id\u003c/var\u003e/attachments/\u003cvar\u003eattachment_id\u003c/var\u003e\u003c/code\u003e.\nLeave this empty on creation.",
+ "type": "string"
},
- "projectId": {
- "type": "string",
- "description": "The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional.",
- "location": "query"
+ "creationTimeMs": {
+ "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.",
+ "type": "string",
+ "format": "google-datetime"
}
- },
- "parameterOrder": [
- "attachmentName"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
},
- "batchDelete": {
- "id": "proximitybeacon.beacons.attachments.batchDelete",
- "path": "v1beta1/{+beaconName}/attachments:batchDelete",
- "httpMethod": "POST",
- "description": "Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "The beacon whose attachments should be deleted. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "namespacedType": {
- "type": "string",
- "description": "Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify \"all types in all namespaces\". Optional.",
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "The project id to delete beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If \"*\" is specified and the projectId string is empty, then the project making the request is used. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "DeleteAttachmentsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- }
- }
+ "id": "BeaconAttachment"
},
- "diagnostics": {
- "methods": {
- "list": {
- "id": "proximitybeacon.beacons.diagnostics.list",
- "path": "v1beta1/{+beaconName}/diagnostics",
- "httpMethod": "GET",
- "description": "List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "beaconName": {
- "type": "string",
- "description": "Beacon that the diagnostics are for.",
- "required": true,
- "pattern": "^beacons/[^/]*$",
- "location": "path"
- },
- "pageSize": {
- "type": "integer",
- "description": "Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.",
- "format": "int32",
- "location": "query"
- },
- "pageToken": {
- "type": "string",
- "description": "Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.",
- "location": "query"
- },
- "alertFilter": {
- "type": "string",
- "description": "Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.",
- "enum": [
- "ALERT_UNSPECIFIED",
- "WRONG_LOCATION",
- "LOW_BATTERY"
- ],
- "location": "query"
- },
- "projectId": {
- "type": "string",
- "description": "Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.",
- "location": "query"
+ "GetInfoForObservedBeaconsResponse": {
+ "description": "Information about the requested beacons, optionally including attachment\ndata.",
+ "type": "object",
+ "properties": {
+ "beacons": {
+ "description": "Public information about beacons.\nMay be empty if the request matched no beacons.",
+ "type": "array",
+ "items": {
+ "$ref": "BeaconInfo"
+ }
}
- },
- "parameterOrder": [
- "beaconName"
- ],
- "response": {
- "$ref": "ListDiagnosticsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- }
- }
- }
- }
- },
- "namespaces": {
- "methods": {
- "list": {
- "id": "proximitybeacon.namespaces.list",
- "path": "v1beta1/namespaces",
- "httpMethod": "GET",
- "description": "Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
- "parameters": {
- "projectId": {
- "type": "string",
- "description": "The project id to list namespaces under. Optional.",
- "location": "query"
- }
- },
- "response": {
- "$ref": "ListNamespacesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- },
- "update": {
- "id": "proximitybeacon.namespaces.update",
- "path": "v1beta1/{+namespaceName}",
- "httpMethod": "PUT",
- "description": "Updates the information about the specified namespace. Only the namespace visibility can be updated.",
- "parameters": {
- "namespaceName": {
- "type": "string",
- "description": "Resource name of this namespace. Namespaces names have the format: namespaces/namespace.",
- "required": true,
- "pattern": "^namespaces/[^/]*$",
- "location": "path"
},
- "projectId": {
- "type": "string",
- "description": "The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
- "location": "query"
- }
- },
- "parameterOrder": [
- "namespaceName"
- ],
- "request": {
- "$ref": "Namespace"
- },
- "response": {
- "$ref": "Namespace"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
+ "id": "GetInfoForObservedBeaconsResponse"
+ },
+ "GetInfoForObservedBeaconsRequest": {
+ "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".",
+ "type": "object",
+ "properties": {
+ "observations": {
+ "description": "The beacons that the client has encountered.\nAt least one must be given.",
+ "type": "array",
+ "items": {
+ "$ref": "Observation"
+ }
+ },
+ "namespacedTypes": {
+ "description": "Specifies what kind of attachments to include in the response.\nWhen given, the response will include only attachments of the given types.\nWhen empty, no attachments will be returned. Must be in the format\n\u003cvar\u003enamespace/type\u003c/var\u003e. Accepts `*` to specify all types in\nall namespaces owned by the client.\nOptional.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "GetInfoForObservedBeaconsRequest"
+ },
+ "ListNamespacesResponse": {
+ "description": "Response to ListNamespacesRequest that contains all the project's namespaces.",
+ "type": "object",
+ "properties": {
+ "namespaces": {
+ "description": "The attachments that corresponded to the request params.",
+ "type": "array",
+ "items": {
+ "$ref": "Namespace"
+ }
+ }
+ },
+ "id": "ListNamespacesResponse"
+ },
+ "Date": {
+ "description": "Represents a whole calendar date, e.g. date of birth. The time of day and\ntime zone are either specified elsewhere or are not significant. The date\nis relative to the Proleptic Gregorian Calendar. The day may be 0 to\nrepresent a year and month where the day is not significant, e.g. credit card\nexpiration date. The year may be 0 to represent a month and day independent\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand `google.protobuf.Timestamp`.",
+ "type": "object",
+ "properties": {
+ "month": {
+ "description": "Month of year. Must be from 1 to 12.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "year": {
+ "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.",
+ "type": "integer",
+ "format": "int32"
+ },
+ "day": {
+ "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0\nif specifying a year/month where the day is not significant.",
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "id": "Date"
+ },
+ "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)\n\nThe code in logs/storage/validator/logs_validator_traits.cc treats this type\nas if it were annotated as ST_LOCATION.",
+ "type": "object",
+ "properties": {
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "type": "number",
+ "format": "double"
+ },
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "type": "number",
+ "format": "double"
+ }
+ },
+ "id": "LatLng"
}
- }
},
- "v1beta1": {
- "methods": {
- "getEidparams": {
- "id": "proximitybeacon.getEidparams",
- "path": "v1beta1/eidparams",
- "httpMethod": "GET",
- "description": "Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.",
- "response": {
- "$ref": "EphemeralIdRegistrationParams"
- },
- "scopes": [
- "https://www.googleapis.com/auth/userlocation.beacon.registry"
- ]
- }
- }
+ "revision": "20170220",
+ "basePath": "",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "beaconinfo": {
- "methods": {
- "getforobserved": {
- "id": "proximitybeacon.beaconinfo.getforobserved",
- "path": "v1beta1/beaconinfo:getforobserved",
- "httpMethod": "POST",
- "description": "Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey) for the application.",
- "request": {
- "$ref": "GetInfoForObservedBeaconsRequest"
- },
- "response": {
- "$ref": "GetInfoForObservedBeaconsResponse"
- }
+ "version_module": "True",
+ "discoveryVersion": "v1",
+ "baseUrl": "https://proximitybeacon.googleapis.com/",
+ "name": "proximitybeacon",
+ "parameters": {
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "default": "true",
+ "type": "boolean",
+ "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"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "location": "query",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "default": "json",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "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"
}
- }
- }
- }
+ },
+ "documentationLink": "https://developers.google.com/beacons/proximity/",
+ "ownerDomain": "google.com",
+ "batchPath": "batch",
+ "servicePath": "",
+ "ownerName": "Google",
+ "version": "v1beta1",
+ "rootUrl": "https://proximitybeacon.googleapis.com/",
+ "kind": "discovery#restDescription"
}
diff --git a/proximitybeacon/v1beta1/proximitybeacon-gen.go b/proximitybeacon/v1beta1/proximitybeacon-gen.go
index efaddd0..bc1e863 100644
--- a/proximitybeacon/v1beta1/proximitybeacon-gen.go
+++ b/proximitybeacon/v1beta1/proximitybeacon-gen.go
@@ -153,21 +153,31 @@
// the device.
type AdvertisedId struct {
// Id: The actual beacon identifier, as broadcast by the beacon
- // hardware. Must be
+ // hardware. Must
+ // be
// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
- // HTTP requests, and will be so encoded (with padding) in responses.
- // The base64 encoding should be of the binary byte-stream and not any
- // textual (such as hex) representation thereof. Required.
+ // HTTP
+ // requests, and will be so encoded (with padding) in responses. The
+ // base64
+ // encoding should be of the binary byte-stream and not any textual
+ // (such as
+ // hex) representation thereof.
+ // Required.
Id string `json:"id,omitempty"`
- // Type: Specifies the identifier type. Required.
+ // Type: Specifies the identifier type.
+ // Required.
//
// Possible values:
- // "TYPE_UNSPECIFIED"
- // "EDDYSTONE"
- // "IBEACON"
- // "ALTBEACON"
- // "EDDYSTONE_EID"
+ // "TYPE_UNSPECIFIED" - Do not use this value.
+ // "EDDYSTONE" - Eddystone, an open beacon format that supports
+ // Android and iOS
+ // devices
+ // https://github.com/google/eddystone/wiki/Beacon-Specification
+ // "IBEACON" - Apple iBeacon compatible beacon
+ // "ALTBEACON" - See http://altbeacon.org and/or
+ // https://github.com/AltBeacon/spec.
+ // "EDDYSTONE_EID" - Eddystone Ephemeral ID
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Id") to
@@ -193,16 +203,20 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
-// AttachmentInfo: A subset of attachment information served via the
+// AttachmentInfo: A subset of attachment information served via
+// the
// `beaconinfo.getforobserved` method, used when your users encounter
-// your beacons.
+// your
+// beacons.
type AttachmentInfo struct {
// Data: An opaque data container for client-provided data.
Data string `json:"data,omitempty"`
// NamespacedType: Specifies what kind of attachment this is. Tells a
- // client how to interpret the `data` field. Format is namespace/type,
- // for example scrupulous-wombat-12345/welcome-message
+ // client how to
+ // interpret the `data` field. Format is <var>namespace/type</var>,
+ // for
+ // example <code>scrupulous-wombat-12345/welcome-message</code>
NamespacedType string `json:"namespacedType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Data") to
@@ -231,83 +245,124 @@
// Beacon: Details of a beacon device.
type Beacon struct {
// AdvertisedId: The identifier of a beacon as advertised by it. This
- // field must be populated when registering. It may be empty when
- // updating a beacon record because it is ignored in updates. When
- // registering a beacon that broadcasts Eddystone-EID, this field should
- // contain a "stable" Eddystone-UID that identifies the beacon and links
- // it to its attachments. The stable Eddystone-UID is only used for
+ // field must be
+ // populated when registering. It may be empty when updating a
+ // beacon
+ // record because it is ignored in updates.
+ //
+ // When registering a beacon that broadcasts Eddystone-EID, this
+ // field
+ // should contain a "stable" Eddystone-UID that identifies the beacon
+ // and
+ // links it to its attachments. The stable Eddystone-UID is only used
+ // for
// administering the beacon.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
// BeaconName: Resource name of this beacon. A beacon name has the
- // format "beacons/N!beaconId" where the beaconId is the base16 ID
- // broadcast by the beacon and N is a code for the beacon's type.
- // Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for
- // AltBeacon. This field must be left empty when registering. After
- // reading a beacon, clients can use the name for future operations.
+ // format
+ // "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
+ // by
+ // the beacon and N is a code for the beacon's type. Possible values
+ // are
+ // `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.
+ //
+ // This field must be left empty when registering. After reading a
+ // beacon,
+ // clients can use the name for future operations.
BeaconName string `json:"beaconName,omitempty"`
// Description: Free text used to identify and describe the beacon.
- // Maximum length 140 characters. Optional.
+ // Maximum length 140
+ // characters.
+ // Optional.
Description string `json:"description,omitempty"`
// EphemeralIdRegistration: Write-only registration parameters for
- // beacons using Eddystone-EID (remotely resolved ephemeral ID) format.
- // This information will not be populated in API responses. When
- // submitting this data, the `advertised_id` field must contain an ID of
- // type Eddystone-UID. Any other ID type will result in an error.
+ // beacons using Eddystone-EID
+ // (remotely resolved ephemeral ID) format. This information will not
+ // be
+ // populated in API responses. When submitting this data, the
+ // `advertised_id`
+ // field must contain an ID of type Eddystone-UID. Any other ID type
+ // will
+ // result in an error.
EphemeralIdRegistration *EphemeralIdRegistration `json:"ephemeralIdRegistration,omitempty"`
// ExpectedStability: Expected location stability. This is set when the
- // beacon is registered or updated, not automatically detected in any
- // way. Optional.
+ // beacon is registered or
+ // updated, not automatically detected in any way.
+ // Optional.
//
// Possible values:
- // "STABILITY_UNSPECIFIED"
- // "STABLE"
- // "PORTABLE"
- // "MOBILE"
- // "ROVING"
+ // "STABILITY_UNSPECIFIED" - Do not use this value.
+ // "STABLE" - Not expected to move, for example a store's front door.
+ // "PORTABLE" - Usually stable but may move rarely, usually within a
+ // single place,
+ // for example a store display.
+ // "MOBILE" - Moves frequently, for example a personal item or food
+ // truck.
+ // "ROVING" - Moves continuously in service, for example a bus or
+ // train.
ExpectedStability string `json:"expectedStability,omitempty"`
// IndoorLevel: The indoor level information for this beacon, if known.
- // As returned by the Google Maps API. Optional.
+ // As returned by the
+ // Google Maps API.
+ // Optional.
IndoorLevel *IndoorLevel `json:"indoorLevel,omitempty"`
// LatLng: The location of the beacon, expressed as a latitude and
- // longitude pair. This location is given when the beacon is registered
- // or updated. It does not necessarily indicate the actual current
- // location of the beacon. Optional.
+ // longitude pair.
+ // This location is given when the beacon is registered or updated. It
+ // does
+ // not necessarily indicate the actual current location of the
+ // beacon.
+ // Optional.
LatLng *LatLng `json:"latLng,omitempty"`
// PlaceId: The [Google Places API](/places/place-id) Place ID of the
- // place where the beacon is deployed. This is given when the beacon is
- // registered or updated, not automatically detected in any way.
+ // place where
+ // the beacon is deployed. This is given when the beacon is registered
+ // or
+ // updated, not automatically detected in any way.
// Optional.
PlaceId string `json:"placeId,omitempty"`
// Properties: Properties of the beacon device, for example battery type
- // or firmware version. Optional.
+ // or firmware
+ // version.
+ // Optional.
Properties map[string]string `json:"properties,omitempty"`
// ProvisioningKey: Some beacons may require a user to provide an
- // authorization key before changing any of its configuration (e.g.
- // broadcast frames, transmit power). This field provides a place to
- // store and control access to that key. This field is populated in
- // responses to `GET /v1beta1/beacons/3!beaconId` from users with write
- // access to the given beacon. That is to say: If the user is authorized
- // to write the beacon's confidential data in the service, the service
- // considers them authorized to configure the beacon. Note that this key
- // grants nothing on the service, only on the beacon itself.
+ // authorization key before
+ // changing any of its configuration (e.g. broadcast frames, transmit
+ // power).
+ // This field provides a place to store and control access to that
+ // key.
+ // This field is populated in responses to `GET
+ // /v1beta1/beacons/3!beaconId`
+ // from users with write access to the given beacon. That is to say: If
+ // the
+ // user is authorized to write the beacon's confidential data in the
+ // service,
+ // the service considers them authorized to configure the beacon.
+ // Note
+ // that this key grants nothing on the service, only on the beacon
+ // itself.
ProvisioningKey string `json:"provisioningKey,omitempty"`
- // Status: Current status of the beacon. Required.
+ // Status: Current status of the beacon.
+ // Required.
//
// Possible values:
- // "STATUS_UNSPECIFIED"
- // "ACTIVE"
- // "DECOMMISSIONED"
- // "INACTIVE"
+ // "STATUS_UNSPECIFIED" - Do not use this value.
+ // "ACTIVE" - The "normal" in-use state of a beacon.
+ // "DECOMMISSIONED" - Beacon should no longer be used for any purpose.
+ // This is irreversible.
+ // "INACTIVE" - The beacon should not be visible to mobile devices.
+ // This is reversible.
Status string `json:"status,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -340,21 +395,36 @@
// BeaconAttachment: Project-specific data associated with a beacon.
type BeaconAttachment struct {
// AttachmentName: Resource name of this attachment. Attachment names
- // have the format: beacons/beacon_id/attachments/attachment_id. Leave
- // this empty on creation.
+ // have the
+ // format:
+ // <code>beacons/<var>beacon_id</var>/attachments/<var>attachment
+ // _id</var></code>.
+ // Leave this empty on creation.
AttachmentName string `json:"attachmentName,omitempty"`
- // Data: An opaque data container for client-provided data. Must be
+ // CreationTimeMs: The UTC time when this attachment was created, in
+ // milliseconds since the
+ // UNIX epoch.
+ CreationTimeMs string `json:"creationTimeMs,omitempty"`
+
+ // Data: An opaque data container for client-provided data. Must
+ // be
// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
- // HTTP requests, and will be so encoded (with padding) in responses.
+ // HTTP
+ // requests, and will be so encoded (with padding) in
+ // responses.
// Required.
Data string `json:"data,omitempty"`
// NamespacedType: Specifies what kind of attachment this is. Tells a
- // client how to interpret the `data` field. Format is namespace/type.
- // Namespace provides type separation between clients. Type describes
- // the type of `data`, for use by the client when parsing the `data`
- // field. Required.
+ // client how to
+ // interpret the `data` field. Format is <var>namespace/type</var>.
+ // Namespace
+ // provides type separation between clients. Type describes the type
+ // of
+ // `data`, for use by the client when parsing the `data`
+ // field.
+ // Required.
NamespacedType string `json:"namespacedType,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -386,14 +456,14 @@
}
// BeaconInfo: A subset of beacon information served via the
-// `beaconinfo.getforobserved` method, which you call when users of your
-// app encounter your beacons.
+// `beaconinfo.getforobserved`
+// method, which you call when users of your app encounter your beacons.
type BeaconInfo struct {
// AdvertisedId: The ID advertised by the beacon.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
- // Attachments: Attachments matching the type(s) requested. May be empty
- // if no attachment types were requested, or if none matched.
+ // Attachments: Attachments matching the type(s) requested.
+ // May be empty if no attachment types were requested.
Attachments []*AttachmentInfo `json:"attachments,omitempty"`
// BeaconName: The name under which the beacon is registered.
@@ -423,24 +493,30 @@
}
// Date: Represents a whole calendar date, e.g. date of birth. The time
-// of day and time zone are either specified elsewhere or are not
-// significant. The date is relative to the Proleptic Gregorian
-// Calendar. The day may be 0 to represent a year and month where the
-// day is not significant, e.g. credit card expiration date. The year
-// may be 0 to represent a month and day independent of year, e.g.
-// anniversary date. Related types are google.type.TimeOfDay and
-// `google.protobuf.Timestamp`.
+// of day and
+// time zone are either specified elsewhere or are not significant. The
+// date
+// is relative to the Proleptic Gregorian Calendar. The day may be 0
+// to
+// represent a year and month where the day is not significant, e.g.
+// credit card
+// expiration date. The year may be 0 to represent a month and day
+// independent
+// of year, e.g. anniversary date. Related types are
+// google.type.TimeOfDay
+// and `google.protobuf.Timestamp`.
type Date struct {
// Day: Day of month. Must be from 1 to 31 and valid for the year and
- // month, or 0 if specifying a year/month where the day is not
- // significant.
+ // month, or 0
+ // if specifying a year/month where the day is not significant.
Day int64 `json:"day,omitempty"`
// Month: Month of year. Must be from 1 to 12.
Month int64 `json:"month,omitempty"`
// Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
- // without a year.
+ // without
+ // a year.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") to
@@ -506,24 +582,28 @@
// Possible values:
// "ALERT_UNSPECIFIED" - Invalid value. Should never appear.
// "WRONG_LOCATION" - The beacon has been reported in a location
- // different than its registered location. This may indicate that the
- // beacon has been moved. This signal is not 100% accurate, but
- // indicates that further investigation is worth while.
+ // different than its registered
+ // location. This may indicate that the beacon has been moved. This
+ // signal
+ // is not 100% accurate, but indicates that further investigation is
+ // worth
+ // while.
// "LOW_BATTERY" - The battery level for the beacon is low enough
- // that, given the beacon's current use, its battery will run out with
- // in the next 60 days. This indicates that the battery should be
- // replaced soon.
+ // that, given the beacon's
+ // current use, its battery will run out with in the next 60 days.
+ // This
+ // indicates that the battery should be replaced soon.
Alerts []string `json:"alerts,omitempty"`
// BeaconName: Resource name of the beacon. For Eddystone-EID beacons,
- // this may be the beacon's current EID, or the beacon's "stable"
- // Eddystone-UID.
+ // this may
+ // be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
BeaconName string `json:"beaconName,omitempty"`
// EstimatedLowBatteryDate: The date when the battery is expected to be
- // low. If the value is missing then there is no estimate for when the
- // battery will be low. This value is only an estimate, not an exact
- // date.
+ // low. If the value is missing
+ // then there is no estimate for when the battery will be low.
+ // This value is only an estimate, not an exact date.
EstimatedLowBatteryDate *Date `json:"estimatedLowBatteryDate,omitempty"`
// ForceSendFields is a list of field names (e.g. "Alerts") to
@@ -550,11 +630,17 @@
}
// Empty: 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: service Foo { rpc Bar(google.protobuf.Empty) returns
-// (google.protobuf.Empty); } The JSON representation for `Empty` is
-// empty JSON object `{}`.
+// 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:
+//
+// service Foo {
+// rpc Bar(google.protobuf.Empty) returns
+// (google.protobuf.Empty);
+// }
+//
+// The JSON representation for `Empty` is empty JSON object `{}`.
type Empty struct {
// ServerResponse contains the HTTP response code and headers from the
// server.
@@ -562,65 +648,92 @@
}
// EphemeralIdRegistration: Write-only registration parameters for
-// beacons using Eddystone-EID format. Two ways of securely registering
-// an Eddystone-EID beacon with the service are supported: 1. Perform an
-// ECDH key exchange via this API, including a previous call to `GET
-// /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key`
-// and `service_ecdh_public_key` should be populated and
-// `beacon_identity_key` should not be populated. This method ensures
-// that only the two parties in the ECDH key exchange can compute the
-// identity key, which becomes a secret between them. 2. Derive or
-// obtain the beacon's identity key via other secure means (perhaps an
-// ECDH key exchange between the beacon and a mobile device or any other
-// secure method), and then submit the resulting identity key to the
-// service. In this case `beacon_identity_key` field should be
-// populated, and neither of `beacon_ecdh_public_key` nor
-// `service_ecdh_public_key` fields should be. The security of this
-// method depends on how securely the parties involved (in particular
-// the bluetooth client) handle the identity key, and obviously on how
-// securely the identity key was generated. See [the Eddystone
+// beacons using Eddystone-EID format.
+// Two ways of securely registering an Eddystone-EID beacon with the
+// service
+// are supported:
+//
+// 1. Perform an ECDH key exchange via this API, including a previous
+// call
+// to `GET /v1beta1/eidparams`. In this case the fields
+// `beacon_ecdh_public_key` and `service_ecdh_public_key` should be
+// populated and `beacon_identity_key` should not be populated. This
+// method ensures that only the two parties in the ECDH key exchange
+// can
+// compute the identity key, which becomes a secret between them.
+// 2. Derive or obtain the beacon's identity key via other secure means
+// (perhaps an ECDH key exchange between the beacon and a mobile
+// device
+// or any other secure method), and then submit the resulting
+// identity key
+// to the service. In this case `beacon_identity_key` field should
+// be
+// populated, and neither of `beacon_ecdh_public_key` nor
+// `service_ecdh_public_key` fields should be. The security of this
+// method
+// depends on how securely the parties involved (in particular the
+// bluetooth client) handle the identity key, and obviously on how
+// securely the identity key was generated.
+//
+// See [the Eddystone
// specification](https://github.com/google/eddystone/tree/master/eddysto
// ne-eid) at GitHub.
type EphemeralIdRegistration struct {
// BeaconEcdhPublicKey: The beacon's public key used for the Elliptic
- // curve Diffie-Hellman key exchange. When this field is populated,
- // `service_ecdh_public_key` must also be populated, and
- // `beacon_identity_key` must not be.
+ // curve Diffie-Hellman
+ // key exchange. When this field is populated,
+ // `service_ecdh_public_key`
+ // must also be populated, and `beacon_identity_key` must not be.
BeaconEcdhPublicKey string `json:"beaconEcdhPublicKey,omitempty"`
// BeaconIdentityKey: The private key of the beacon. If this field is
- // populated, `beacon_ecdh_public_key` and `service_ecdh_public_key`
- // must not be populated.
+ // populated,
+ // `beacon_ecdh_public_key` and `service_ecdh_public_key` must not
+ // be
+ // populated.
BeaconIdentityKey string `json:"beaconIdentityKey,omitempty"`
// InitialClockValue: The initial clock value of the beacon. The
- // beacon's clock must have begun counting at this value immediately
- // prior to transmitting this value to the resolving service.
- // Significant delay in transmitting this value to the service risks
- // registration or resolution failures. If a value is not provided, the
- // default is zero.
+ // beacon's clock must have
+ // begun counting at this value immediately prior to transmitting
+ // this
+ // value to the resolving service. Significant delay in transmitting
+ // this
+ // value to the service risks registration or resolution failures. If
+ // a
+ // value is not provided, the default is zero.
InitialClockValue uint64 `json:"initialClockValue,omitempty,string"`
// InitialEid: An initial ephemeral ID calculated using the clock value
- // submitted as `initial_clock_value`, and the secret key generated by
- // the Diffie-Hellman key exchange using `service_ecdh_public_key` and
- // `service_ecdh_public_key`. This initial EID value will be used by the
+ // submitted as
+ // `initial_clock_value`, and the secret key generated by
+ // the
+ // Diffie-Hellman key exchange using `service_ecdh_public_key`
+ // and
+ // `service_ecdh_public_key`. This initial EID value will be used by
+ // the
// service to confirm that the key exchange process was successful.
InitialEid string `json:"initialEid,omitempty"`
// RotationPeriodExponent: Indicates the nominal period between each
- // rotation of the beacon's ephemeral ID. "Nominal" because the beacon
- // should randomize the actual interval. See [the spec at
+ // rotation of the beacon's
+ // ephemeral ID. "Nominal" because the beacon should randomize
+ // the
+ // actual interval. See [the spec at
// github](https://github.com/google/eddystone/tree/master/eddystone-eid)
- // for details. This value corresponds to a power-of-two scaler on the
- // beacon's clock: when the scaler value is K, the beacon will begin
+ //
+ // for details. This value corresponds to a power-of-two scaler on
+ // the
+ // beacon's clock: when the scaler value is K, the beacon will
+ // begin
// broadcasting a new ephemeral ID on average every 2^K seconds.
RotationPeriodExponent int64 `json:"rotationPeriodExponent,omitempty"`
// ServiceEcdhPublicKey: The service's public key used for the Elliptic
- // curve Diffie-Hellman key exchange. When this field is populated,
- // `beacon_ecdh_public_key` must also be populated, and
- // `beacon_identity_key` must not be.
+ // curve Diffie-Hellman
+ // key exchange. When this field is populated,
+ // `beacon_ecdh_public_key`
+ // must also be populated, and `beacon_identity_key` must not be.
ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`
// ForceSendFields is a list of field names (e.g. "BeaconEcdhPublicKey")
@@ -648,25 +761,27 @@
}
// EphemeralIdRegistrationParams: Information a client needs to
-// provision and register beacons that broadcast Eddystone-EID format
-// beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See
+// provision and register beacons that
+// broadcast Eddystone-EID format beacon IDs, using Elliptic
+// curve
+// Diffie-Hellman key exchange. See
// [the Eddystone
// specification](https://github.com/google/eddystone/tree/master/eddysto
// ne-eid) at GitHub.
type EphemeralIdRegistrationParams struct {
// MaxRotationPeriodExponent: Indicates the maximum rotation period
- // supported by the service. See
- // EddystoneEidRegistration.rotation_period_exponent
+ // supported by the service.
+ // See EddystoneEidRegistration.rotation_period_exponent
MaxRotationPeriodExponent int64 `json:"maxRotationPeriodExponent,omitempty"`
// MinRotationPeriodExponent: Indicates the minimum rotation period
- // supported by the service. See
- // EddystoneEidRegistration.rotation_period_exponent
+ // supported by the service.
+ // See EddystoneEidRegistration.rotation_period_exponent
MinRotationPeriodExponent int64 `json:"minRotationPeriodExponent,omitempty"`
// ServiceEcdhPublicKey: The beacon service's public key for use by a
- // beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman
- // key exchange.
+ // beacon to derive its
+ // Identity Key using Elliptic Curve Diffie-Hellman key exchange.
ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -699,18 +814,22 @@
}
// GetInfoForObservedBeaconsRequest: Request for beacon and attachment
-// information about beacons that a mobile client has encountered "in
-// the wild".
+// information about beacons that
+// a mobile client has encountered "in the wild".
type GetInfoForObservedBeaconsRequest struct {
// NamespacedTypes: Specifies what kind of attachments to include in the
- // response. When given, the response will include only attachments of
- // the given types. When empty, no attachments will be returned. Must be
- // in the format namespace/type. Accepts `*` to specify all types in all
- // namespaces. Optional.
+ // response.
+ // When given, the response will include only attachments of the given
+ // types.
+ // When empty, no attachments will be returned. Must be in the
+ // format
+ // <var>namespace/type</var>. Accepts `*` to specify all types in
+ // all namespaces owned by the client.
+ // Optional.
NamespacedTypes []string `json:"namespacedTypes,omitempty"`
- // Observations: The beacons that the client has encountered. At least
- // one must be given.
+ // Observations: The beacons that the client has encountered.
+ // At least one must be given.
Observations []*Observation `json:"observations,omitempty"`
// ForceSendFields is a list of field names (e.g. "NamespacedTypes") to
@@ -738,10 +857,11 @@
}
// GetInfoForObservedBeaconsResponse: Information about the requested
-// beacons, optionally including attachment data.
+// beacons, optionally including attachment
+// data.
type GetInfoForObservedBeaconsResponse struct {
- // Beacons: Public information about beacons. May be empty if the
- // request matched no beacons.
+ // Beacons: Public information about beacons.
+ // May be empty if the request matched no beacons.
Beacons []*BeaconInfo `json:"beacons,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -772,8 +892,8 @@
}
// IndoorLevel: Indoor level, a human-readable string as returned by
-// Google Maps APIs, useful to indicate which floor of a building a
-// beacon is located on.
+// Google Maps APIs,
+// useful to indicate which floor of a building a beacon is located on.
type IndoorLevel struct {
// Name: The name of this level.
Name string `json:"name,omitempty"`
@@ -802,29 +922,52 @@
}
// LatLng: An object representing a latitude/longitude pair. This is
-// expressed as a pair of doubles representing degrees latitude and
-// degrees longitude. Unless specified otherwise, this must conform to
-// the WGS84 standard. Values must be within normalized ranges. Example
-// of normalization code in Python: def NormalizeLongitude(longitude):
-// """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r =
-// divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0):
-// return r - 360.0 return r def NormalizeLatLng(latitude, longitude):
-// """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and
-// [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0:
-// return r - 360, NormalizeLongitude(longitude) else: return 180 - r,
-// NormalizeLongitude(longitude + 180.0) assert 180.0 ==
-// NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0)
-// assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) ==
-// NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) ==
-// NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) ==
-// NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) ==
-// NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) ==
-// NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) ==
-// NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) ==
-// NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) ==
-// NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) ==
-// NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) ==
-// NormalizeLatLng(-270.0, 10.0)
+// expressed as a pair
+// of doubles representing degrees latitude and degrees longitude.
+// Unless
+// specified otherwise, this must conform to the
+// <a
+// href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
+// st
+// andard</a>. Values must be within normalized ranges.
+//
+// Example of normalization code in Python:
+//
+// def NormalizeLongitude(longitude):
+// """Wraps decimal degrees longitude to [-180.0, 180.0]."""
+// q, r = divmod(longitude, 360.0)
+// if r > 180.0 or (r == 180.0 and q <= -1.0):
+// return r - 360.0
+// return r
+//
+// def NormalizeLatLng(latitude, longitude):
+// """Wraps decimal degrees latitude and longitude to
+// [-90.0, 90.0] and [-180.0, 180.0], respectively."""
+// r = latitude % 360.0
+// if r <= 90.0:
+// return r, NormalizeLongitude(longitude)
+// elif r >= 270.0:
+// return r - 360, NormalizeLongitude(longitude)
+// else:
+// return 180 - r, NormalizeLongitude(longitude + 180.0)
+//
+// assert 180.0 == NormalizeLongitude(180.0)
+// assert -180.0 == NormalizeLongitude(-180.0)
+// assert -179.0 == NormalizeLongitude(181.0)
+// assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0)
+// assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0)
+// assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0)
+// assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0)
+// assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0)
+// assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0)
+// assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0)
+// assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0)
+// assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0)
+// assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
+//
+// The code in logs/storage/validator/logs_validator_traits.cc treats
+// this type
+// as if it were annotated as ST_LOCATION.
type LatLng struct {
// Latitude: The latitude in degrees. It must be in the range [-90.0,
// +90.0].
@@ -873,8 +1016,8 @@
return nil
}
-// ListBeaconAttachmentsResponse: Response to ListBeaconAttachments that
-// contains the requested attachments.
+// ListBeaconAttachmentsResponse: Response to `ListBeaconAttachments`
+// that contains the requested attachments.
type ListBeaconAttachmentsResponse struct {
// Attachments: The attachments that corresponded to the request params.
Attachments []*BeaconAttachment `json:"attachments,omitempty"`
@@ -913,11 +1056,13 @@
Beacons []*Beacon `json:"beacons,omitempty"`
// NextPageToken: An opaque pagination token that the client may provide
- // in their next request to retrieve the next page of results.
+ // in their next
+ // request to retrieve the next page of results.
NextPageToken string `json:"nextPageToken,omitempty"`
// TotalCount: Estimate of the total number of beacons matched by the
- // query. Higher values may be less accurate.
+ // query. Higher
+ // values may be less accurate.
TotalCount int64 `json:"totalCount,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the
@@ -954,8 +1099,8 @@
Diagnostics []*Diagnostics `json:"diagnostics,omitempty"`
// NextPageToken: Token that can be used for pagination. Returned only
- // if the request matches more beacons than can be returned in this
- // response.
+ // if the
+ // request matches more beacons than can be returned in this response.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1019,21 +1164,26 @@
}
// Namespace: An attachment namespace defines read and write access for
-// all the attachments created under it. Each namespace is globally
-// unique, and owned by one project which is the only project that can
-// create attachments under it.
+// all the attachments
+// created under it. Each namespace is globally unique, and owned by
+// one
+// project which is the only project that can create attachments under
+// it.
type Namespace struct {
// NamespaceName: Resource name of this namespace. Namespaces names have
- // the format: namespaces/namespace.
+ // the format:
+ // <code>namespaces/<var>namespace</var></code>.
NamespaceName string `json:"namespaceName,omitempty"`
// ServingVisibility: Specifies what clients may receive attachments
- // under this namespace via `beaconinfo.getforobserved`.
+ // under this namespace
+ // via `beaconinfo.getforobserved`.
//
// Possible values:
- // "VISIBILITY_UNSPECIFIED"
- // "UNLISTED"
- // "PUBLIC"
+ // "VISIBILITY_UNSPECIFIED" - Do not use this value.
+ // "UNLISTED" - Served only to the project that owns the namespace.
+ // "PUBLIC" - Any project can subscribe to attachments under the
+ // namespace.
ServingVisibility string `json:"servingVisibility,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -1066,14 +1216,21 @@
// Observation: Represents one beacon observed once.
type Observation struct {
// AdvertisedId: The ID advertised by the beacon the client has
- // encountered. Clients may submit an Eddystone-EID `advertised_id`. If
- // the client is not authorized to resolve the given Eddystone-EID, no
- // data will be returned for that beacon. Required.
+ // encountered.
+ //
+ // If the submitted `advertised_id` type is Eddystone-EID, then the
+ // client
+ // must be authorized to resolve the given beacon. Otherwise no data
+ // will be
+ // returned for that beacon.
+ // Required.
AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`
// Telemetry: The array of telemetry bytes received from the beacon. The
- // server is responsible for parsing it. This field may frequently be
- // empty, as with a beacon that transmits telemetry only occasionally.
+ // server is
+ // responsible for parsing it. This field may frequently be empty,
+ // as
+ // with a beacon that transmits telemetry only occasionally.
Telemetry string `json:"telemetry,omitempty"`
// TimestampMs: Time when the beacon was observed.
@@ -1113,10 +1270,13 @@
}
// Getforobserved: Given one or more beacon observations, returns any
-// beacon information and attachments accessible to your application.
-// Authorize by using the [API
+// beacon information
+// and attachments accessible to your application. Authorize by using
+// the
+// [API
// key](https://developers.google.com/beacons/proximity/how-tos/authorizi
-// ng#APIKey) for the application.
+// ng#APIKey)
+// for the application.
func (r *BeaconinfoService) Getforobserved(getinfoforobservedbeaconsrequest *GetInfoForObservedBeaconsRequest) *BeaconinfoGetforobservedCall {
c := &BeaconinfoGetforobservedCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.getinfoforobservedbeaconsrequest = getinfoforobservedbeaconsrequest
@@ -1208,9 +1368,12 @@
}
return ret, nil
// {
- // "description": "Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/how-tos/authorizing#APIKey) for the application.",
+ // "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/how-tos/authorizing#APIKey)\nfor the application.",
+ // "flatPath": "v1beta1/beaconinfo:getforobserved",
// "httpMethod": "POST",
// "id": "proximitybeacon.beaconinfo.getforobserved",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v1beta1/beaconinfo:getforobserved",
// "request": {
// "$ref": "GetInfoForObservedBeaconsRequest"
@@ -1233,12 +1396,17 @@
}
// Activate: Activates a beacon. A beacon that is active will return
-// information and attachment data when queried via
-// `beaconinfo.getforobserved`. Calling this method on an already active
-// beacon will do nothing (but will return a successful response code).
+// information
+// and attachment data when queried via
+// `beaconinfo.getforobserved`.
+// Calling this method on an already active beacon will do nothing
+// (but
+// will return a successful response code).
+//
// Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsService) Activate(beaconName string) *BeaconsActivateCall {
c := &BeaconsActivateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -1247,9 +1415,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the beacon to activate. If the project id is not specified then the
-// project making the request is used. The project id must match the
-// project that owns the beacon.
+// the beacon to activate. If the project id is not
+// specified then the project making the request is used. The project
+// id
+// must match the project that owns the beacon.
func (c *BeaconsActivateCall) ProjectId(projectId string) *BeaconsActivateCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -1337,7 +1506,8 @@
}
return ret, nil
// {
- // "description": "Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}:activate",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.activate",
// "parameterOrder": [
@@ -1345,14 +1515,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Beacon that should be activated. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -1379,12 +1549,18 @@
}
// Deactivate: Deactivates a beacon. Once deactivated, the API will not
-// return information nor attachment data for the beacon when queried
-// via `beaconinfo.getforobserved`. Calling this method on an already
-// inactive beacon will do nothing (but will return a successful
-// response code). Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// return
+// information nor attachment data for the beacon when queried
+// via
+// `beaconinfo.getforobserved`. Calling this method on an already
+// inactive
+// beacon will do nothing (but will return a successful response
+// code).
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsService) Deactivate(beaconName string) *BeaconsDeactivateCall {
c := &BeaconsDeactivateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -1393,9 +1569,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the beacon to deactivate. If the project id is not specified then the
-// project making the request is used. The project id must match the
-// project that owns the beacon.
+// the beacon to deactivate. If the project id is not
+// specified then the project making the request is used. The project id
+// must
+// match the project that owns the beacon.
func (c *BeaconsDeactivateCall) ProjectId(projectId string) *BeaconsDeactivateCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -1483,7 +1660,8 @@
}
return ret, nil
// {
- // "description": "Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code). Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}:deactivate",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.deactivate",
// "parameterOrder": [
@@ -1491,14 +1669,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Beacon that should be deactivated. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -1525,11 +1703,17 @@
}
// Decommission: Decommissions the specified beacon in the service. This
-// beacon will no longer be returned from `beaconinfo.getforobserved`.
-// This operation is permanent -- you will not be able to re-register a
-// beacon with this ID again. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// beacon will no
+// longer be returned from `beaconinfo.getforobserved`. This operation
+// is
+// permanent -- you will not be able to re-register a beacon with this
+// ID
+// again.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsService) Decommission(beaconName string) *BeaconsDecommissionCall {
c := &BeaconsDecommissionCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -1538,9 +1722,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the beacon to decommission. If the project id is not specified then
-// the project making the request is used. The project id must match the
-// project that owns the beacon.
+// the beacon to decommission. If the project id is not
+// specified then the project making the request is used. The project
+// id
+// must match the project that owns the beacon.
func (c *BeaconsDecommissionCall) ProjectId(projectId string) *BeaconsDecommissionCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -1628,7 +1813,8 @@
}
return ret, nil
// {
- // "description": "Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}:decommission",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.decommission",
// "parameterOrder": [
@@ -1636,14 +1822,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Beacon that should be decommissioned. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -1659,6 +1845,155 @@
}
+// method id "proximitybeacon.beacons.delete":
+
+type BeaconsDeleteCall struct {
+ s *Service
+ beaconName string
+ urlParams_ gensupport.URLParams
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Delete: Deletes the specified beacon including all diagnostics data
+// for the beacon
+// as well as any attachments on the beacon (including those belonging
+// to
+// other projects). This operation cannot be undone.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
+// Google Developers Console project.
+func (r *BeaconsService) Delete(beaconName string) *BeaconsDeleteCall {
+ c := &BeaconsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.beaconName = beaconName
+ return c
+}
+
+// ProjectId sets the optional parameter "projectId": The project id of
+// the beacon to delete. If not provided, the project
+// that is making the request is used.
+func (c *BeaconsDeleteCall) ProjectId(projectId string) *BeaconsDeleteCall {
+ c.urlParams_.Set("projectId", projectId)
+ 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 *BeaconsDeleteCall) Fields(s ...googleapi.Field) *BeaconsDeleteCall {
+ 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 *BeaconsDeleteCall) Context(ctx context.Context) *BeaconsDeleteCall {
+ 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 *BeaconsDeleteCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *BeaconsDeleteCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ var body io.Reader = nil
+ c.urlParams_.Set("alt", alt)
+ urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+beaconName}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("DELETE", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "beaconName": c.beaconName,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "proximitybeacon.beacons.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 *BeaconsDeleteCall) 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 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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}",
+ // "httpMethod": "DELETE",
+ // "id": "proximitybeacon.beacons.delete",
+ // "parameterOrder": [
+ // "beaconName"
+ // ],
+ // "parameters": {
+ // "beaconName": {
+ // "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.",
+ // "location": "path",
+ // "pattern": "^beacons/[^/]+$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "projectId": {
+ // "description": "The project id of the beacon to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1beta1/{+beaconName}",
+ // "response": {
+ // "$ref": "Empty"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/userlocation.beacon.registry"
+ // ]
+ // }
+
+}
+
// method id "proximitybeacon.beacons.get":
type BeaconsGetCall struct {
@@ -1670,16 +2005,24 @@
header_ http.Header
}
-// Get: Returns detailed information about the specified beacon.
+// Get: Returns detailed information about the specified
+// beacon.
+//
// Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **viewer**, **Is owner** or **Can edit**
-// permissions in the Google Developers Console project. Requests may
-// supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId`
-// where the `beaconId` is the base16 ephemeral ID broadcast by the
-// beacon. The returned `Beacon` object will contain the beacon's stable
-// Eddystone-UID. Clients not authorized to resolve the beacon's
-// ephemeral Eddystone-EID broadcast will receive an error.
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **viewer**, **Is owner** or **Can
+// edit**
+// permissions in the Google Developers Console project.
+//
+// Requests may supply an Eddystone-EID beacon name in the
+// form:
+// `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral
+// ID
+// broadcast by the beacon. The returned `Beacon` object will contain
+// the
+// beacon's stable Eddystone-UID. Clients not authorized to resolve
+// the
+// beacon's ephemeral Eddystone-EID broadcast will receive an error.
func (r *BeaconsService) Get(beaconName string) *BeaconsGetCall {
c := &BeaconsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.beaconName = beaconName
@@ -1687,8 +2030,9 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the beacon to request. If the project id is not specified then the
-// project making the request is used. The project id must match the
+// the beacon to request. If the project id is not specified
+// then the project making the request is used. The project id must
+// match the
// project that owns the beacon.
func (c *BeaconsGetCall) ProjectId(projectId string) *BeaconsGetCall {
c.urlParams_.Set("projectId", projectId)
@@ -1790,7 +2134,8 @@
}
return ret, nil
// {
- // "description": "Returns detailed information about the specified beacon. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}",
// "httpMethod": "GET",
// "id": "proximitybeacon.beacons.get",
// "parameterOrder": [
@@ -1798,14 +2143,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -1832,10 +2177,15 @@
}
// List: Searches the beacon registry for beacons that match the given
-// search criteria. Only those beacons that the client has permission to
-// list will be returned. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **viewer**, **Is owner** or **Can edit**
+// search
+// criteria. Only those beacons that the client has permission to
+// list
+// will be returned.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **viewer**, **Is owner** or **Can
+// edit**
// permissions in the Google Developers Console project.
func (r *BeaconsService) List() *BeaconsListCall {
c := &BeaconsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -1843,8 +2193,8 @@
}
// PageSize sets the optional parameter "pageSize": The maximum number
-// of records to return for this request, up to a server-defined upper
-// limit.
+// of records to return for this request, up to a
+// server-defined upper limit.
func (c *BeaconsListCall) PageSize(pageSize int64) *BeaconsListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
@@ -1858,58 +2208,100 @@
}
// ProjectId sets the optional parameter "projectId": The project id to
-// list beacons under. If not present then the project credential that
-// made the request is used as the project.
+// list beacons under. If not present then the project
+// credential that made the request is used as the project.
func (c *BeaconsListCall) ProjectId(projectId string) *BeaconsListCall {
c.urlParams_.Set("projectId", projectId)
return c
}
// Q sets the optional parameter "q": Filter query string that supports
-// the following field filters: * `description:"" For example:
-// `description:"Room 3" Returns beacons whose description matches
-// tokens in the string "Room 3" (not necessarily that exact string).
-// The string must be double-quoted. * `status:` For example:
-// `status:active` Returns beacons whose status matches the given value.
-// Values must be one of the Beacon.Status enum values (case
-// insensitive). Accepts multiple filters which will be combined with OR
-// logic. * `stability:` For example: `stability:mobile` Returns beacons
-// whose expected stability matches the given value. Values must be one
-// of the Beacon.Stability enum values (case insensitive). Accepts
-// multiple filters which will be combined with OR logic. *
-// `place_id:"" For example: `place_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="
-// Returns beacons explicitly registered at the given place, expressed
-// as a Place ID obtained from [Google Places API](/places/place-id).
-// Does not match places inside the given place. Does not consider the
-// beacon's actual location (which may be different from its registered
-// place). Accepts multiple filters that will be combined with OR logic.
-// The place ID must be double-quoted. * `registration_time[|=]` For
-// example: `registration_time>=1433116800` Returns beacons whose
-// registration time matches the given filter. Supports the operators: ,
-// =. Timestamp must be expressed as an integer number of seconds since
-// midnight January 1, 1970 UTC. Accepts at most two filters that will
-// be combined with AND logic, to support "between" semantics. If more
-// than two are supplied, the latter ones are ignored. * `lat: lng:
-// radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000`
-// Returns beacons whose registered location is within the given circle.
-// When any of these fields are given, all are required. Latitude and
-// longitude must be decimal degrees between -90.0 and 90.0 and between
-// -180.0 and 180.0 respectively. Radius must be an integer number of
-// meters between 10 and 1,000,000 (1000 km). * `property:"=" For
-// example: `property:"battery-type=CR2032" Returns beacons which have
-// a property of the given name and value. Supports multiple filters
-// which will be combined with OR logic. The entire name=value string
-// must be double-quoted as one string. * `attachment_type:"" For
-// example: `attachment_type:"my-namespace/my-type" Returns beacons
-// having at least one attachment of the given namespaced type. Supports
-// "any within this namespace" via the partial wildcard syntax:
-// "my-namespace/*". Supports multiple filters which will be combined
-// with OR logic. The string must be double-quoted. Multiple filters on
-// the same field are combined with OR logic (except registration_time
-// which is combined with AND logic). Multiple filters on different
-// fields are combined with AND logic. Filters should be separated by
-// spaces. As with any HTTP query string parameter, the whole filter
-// expression must be URL-encoded. Example REST request: `GET
+// the following field filters:
+//
+// * **description:"<string>"**
+// For example: **description:"Room 3"**
+// Returns beacons whose description matches tokens in the string
+// "Room 3"
+// (not necessarily that exact string).
+// The string must be double-quoted.
+// * **status:`<enum>`**
+// For example: **status:active**
+// Returns beacons whose status matches the given value. Values must
+// be
+// one of the Beacon.Status enum values (case insensitive). Accepts
+// multiple filters which will be combined with OR logic.
+// * **stability:`<enum>`**
+// For example: **stability:mobile**
+// Returns beacons whose expected stability matches the given value.
+// Values must be one of the Beacon.Stability enum values (case
+// insensitive). Accepts multiple filters which will be combined with
+// OR logic.
+// * **place\_id:"<string>"**
+// For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="**
+// Returns beacons explicitly registered at the given place, expressed
+// as
+// a Place ID obtained from [Google Places API](/places/place-id).
+// Does not
+// match places inside the given place. Does not consider the
+// beacon's
+// actual location (which may be different from its registered
+// place).
+// Accepts multiple filters that will be combined with OR logic. The
+// place
+// ID must be double-quoted.
+// * **registration\_time`[<|>|<=|>=]<integer>`**
+// For example: **registration\_time>=1433116800**
+// Returns beacons whose registration time matches the given filter.
+// Supports the operators: <, >, <=, and >=. Timestamp must be
+// expressed as
+// an integer number of seconds since midnight January 1, 1970 UTC.
+// Accepts
+// at most two filters that will be combined with AND logic, to
+// support
+// "between" semantics. If more than two are supplied, the latter ones
+// are
+// ignored.
+// * **lat:`<double> lng:<double> radius:<integer>`**
+// For example: **lat:51.1232343 lng:-1.093852 radius:1000**
+// Returns beacons whose registered location is within the given
+// circle.
+// When any of these fields are given, all are required. Latitude and
+// longitude must be decimal degrees between -90.0 and 90.0 and
+// between
+// -180.0 and 180.0 respectively. Radius must be an integer number of
+// meters between 10 and 1,000,000 (1000 km).
+// * **property:"<string>=<string>"**
+// For example: **property:"battery-type=CR2032"**
+// Returns beacons which have a property of the given name and value.
+// Supports multiple filters which will be combined with OR logic.
+// The entire name=value string must be double-quoted as one string.
+// * **attachment\_type:"<string>"**
+// For example: **attachment_type:"my-namespace/my-type"**
+// Returns beacons having at least one attachment of the given
+// namespaced
+// type. Supports "any within this namespace" via the partial
+// wildcard
+// syntax: "my-namespace/*". Supports multiple filters which will be
+// combined with OR logic. The string must be double-quoted.
+// * **indoor\_level:"<string>"**
+// For example: **indoor\_level:"1"**
+// Returns beacons which are located on the given indoor level.
+// Accepts
+// multiple filters that will be combined with OR logic.
+//
+// Multiple filters on the same field are combined with OR logic
+// (except
+// registration_time which is combined with AND logic).
+// Multiple filters on different fields are combined with AND
+// logic.
+// Filters should be separated by spaces.
+//
+// As with any HTTP query string parameter, the whole filter expression
+// must
+// be URL-encoded.
+//
+// Example REST request:
+// `GET
// /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:10
// 00`
func (c *BeaconsListCall) Q(q string) *BeaconsListCall {
@@ -2009,12 +2401,14 @@
}
return ret, nil
// {
- // "description": "Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons",
// "httpMethod": "GET",
// "id": "proximitybeacon.beacons.list",
+ // "parameterOrder": [],
// "parameters": {
// "pageSize": {
- // "description": "The maximum number of records to return for this request, up to a server-defined upper limit.",
+ // "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.",
// "format": "int32",
// "location": "query",
// "type": "integer"
@@ -2025,12 +2419,12 @@
// "type": "string"
// },
// "projectId": {
- // "description": "The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
// "q": {
- // "description": "Filter query string that supports the following field filters: * `description:\"\"` For example: `description:\"Room 3\"` Returns beacons whose description matches tokens in the string \"Room 3\" (not necessarily that exact string). The string must be double-quoted. * `status:` For example: `status:active` Returns beacons whose status matches the given value. Values must be one of the Beacon.Status enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `stability:` For example: `stability:mobile` Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic. * `place_id:\"\"` For example: `place_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"` Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from [Google Places API](/places/place-id). Does not match places inside the given place. Does not consider the beacon's actual location (which may be different from its registered place). Accepts multiple filters that will be combined with OR logic. The place ID must be double-quoted. * `registration_time[|=]` For example: `registration_time\u003e=1433116800` Returns beacons whose registration time matches the given filter. Supports the operators: , =. Timestamp must be expressed as an integer number of seconds since midnight January 1, 1970 UTC. Accepts at most two filters that will be combined with AND logic, to support \"between\" semantics. If more than two are supplied, the latter ones are ignored. * `lat: lng: radius:` For example: `lat:51.1232343 lng:-1.093852 radius:1000` Returns beacons whose registered location is within the given circle. When any of these fields are given, all are required. Latitude and longitude must be decimal degrees between -90.0 and 90.0 and between -180.0 and 180.0 respectively. Radius must be an integer number of meters between 10 and 1,000,000 (1000 km). * `property:\"=\"` For example: `property:\"battery-type=CR2032\"` Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string. * `attachment_type:\"\"` For example: `attachment_type:\"my-namespace/my-type\"` Returns beacons having at least one attachment of the given namespaced type. Supports \"any within this namespace\" via the partial wildcard syntax: \"my-namespace/*\". Supports multiple filters which will be combined with OR logic. The string must be double-quoted. Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces. As with any HTTP query string parameter, the whole filter expression must be URL-encoded. Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`",
+ // "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`",
// "location": "query",
// "type": "string"
// }
@@ -2078,10 +2472,14 @@
}
// Register: Registers a previously unregistered beacon given its
-// `advertisedId`. These IDs are unique within the system. An ID can be
-// registered only once. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// `advertisedId`.
+// These IDs are unique within the system. An ID can be registered only
+// once.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsService) Register(beacon *Beacon) *BeaconsRegisterCall {
c := &BeaconsRegisterCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2090,8 +2488,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the project the beacon will be registered to. If the project id is
-// not specified then the project making the request is used.
+// the project the beacon will be registered to. If
+// the project id is not specified then the project making the
+// request
+// is used.
func (c *BeaconsRegisterCall) ProjectId(projectId string) *BeaconsRegisterCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2181,12 +2581,14 @@
}
return ret, nil
// {
- // "description": "Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons:register",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.register",
+ // "parameterOrder": [],
// "parameters": {
// "projectId": {
- // "description": "The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -2217,15 +2619,22 @@
}
// Update: Updates the information about the specified beacon. **Any
-// field that you do not populate in the submitted beacon will be
-// permanently erased**, so you should follow the "read, modify, write"
-// pattern to avoid inadvertently destroying data. Changes to the beacon
-// status via this method will be silently ignored. To update beacon
-// status, use the separate methods on this API for activation,
-// deactivation, and decommissioning. Authenticate using an [OAuth
-// access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// field that you do
+// not populate in the submitted beacon will be permanently erased**, so
+// you
+// should follow the "read, modify, write" pattern to avoid
+// inadvertently
+// destroying data.
+//
+// Changes to the beacon status via this method will be silently
+// ignored.
+// To update beacon status, use the separate methods on this API
+// for
+// activation, deactivation, and decommissioning.
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsService) Update(beaconName string, beacon *Beacon) *BeaconsUpdateCall {
c := &BeaconsUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2235,9 +2644,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the beacon to update. If the project id is not specified then the
-// project making the request is used. The project id must match the
-// project that owns the beacon.
+// the beacon to update. If the project id is not
+// specified then the project making the request is used. The project
+// id
+// must match the project that owns the beacon.
func (c *BeaconsUpdateCall) ProjectId(projectId string) *BeaconsUpdateCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2330,7 +2740,8 @@
}
return ret, nil
// {
- // "description": "Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the \"read, modify, write\" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}",
// "httpMethod": "PUT",
// "id": "proximitybeacon.beacons.update",
// "parameterOrder": [
@@ -2338,14 +2749,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Resource name of this beacon. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.",
+ // "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -2375,13 +2786,21 @@
}
// BatchDelete: Deletes multiple attachments on a given beacon. This
-// operation is permanent and cannot be undone. You can optionally
-// specify `namespacedType` to choose which attachments should be
-// deleted. If you do not specify `namespacedType`, all your attachments
-// on the given beacon will be deleted. You also may explicitly specify
-// `*/*` to delete all. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// operation is
+// permanent and cannot be undone.
+//
+// You can optionally specify `namespacedType` to choose which
+// attachments
+// should be deleted. If you do not specify `namespacedType`, all
+// your
+// attachments on the given beacon will be deleted. You also may
+// explicitly
+// specify `*/*` to delete all.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsAttachmentsService) BatchDelete(beaconName string) *BeaconsAttachmentsBatchDeleteCall {
c := &BeaconsAttachmentsBatchDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2390,20 +2809,23 @@
}
// NamespacedType sets the optional parameter "namespacedType":
-// Specifies the namespace and type of attachments to delete in
-// `namespace/type` format. Accepts `*/*` to specify "all types in all
-// namespaces".
+// Specifies the namespace and type of attachments to delete
+// in
+// `namespace/type` format. Accepts `*/*` to specify
+// "all types in all namespaces".
func (c *BeaconsAttachmentsBatchDeleteCall) NamespacedType(namespacedType string) *BeaconsAttachmentsBatchDeleteCall {
c.urlParams_.Set("namespacedType", namespacedType)
return c
}
// ProjectId sets the optional parameter "projectId": The project id to
-// delete beacon attachments under. This field can be used when "*" is
-// specified to mean all attachment namespaces. Projects may have
-// multiple attachments with multiple namespaces. If "*" is specified
-// and the projectId string is empty, then the project making the
-// request is used.
+// delete beacon attachments under. This field can be
+// used when "*" is specified to mean all attachment namespaces.
+// Projects
+// may have multiple attachments with multiple namespaces. If "*"
+// is
+// specified and the projectId string is empty, then the project
+// making the request is used.
func (c *BeaconsAttachmentsBatchDeleteCall) ProjectId(projectId string) *BeaconsAttachmentsBatchDeleteCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2491,7 +2913,8 @@
}
return ret, nil
// {
- // "description": "Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone. You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.attachments.batchDelete",
// "parameterOrder": [
@@ -2499,19 +2922,19 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "The beacon whose attachments should be deleted. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "namespacedType": {
- // "description": "Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify \"all types in all namespaces\". Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
- // "description": "The project id to delete beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If \"*\" is specified and the projectId string is empty, then the project making the request is used. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -2539,16 +2962,26 @@
}
// Create: Associates the given data with the specified beacon.
-// Attachment data must contain two parts:
-// - A namespaced type.
-// - The actual attachment data itself. The namespaced type consists of
-// two parts, the namespace and the type. The namespace must be one of
-// the values returned by the `namespaces` endpoint, while the type can
-// be a string of any characters except for the forward slash (`/`) up
-// to 100 characters in length. Attachment data can be up to 1024 bytes
-// long. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// Attachment data must
+// contain two parts:
+// <ul>
+// <li>A namespaced type.</li>
+// <li>The actual attachment data itself.</li>
+// </ul>
+// The namespaced type consists of two parts, the namespace and the
+// type.
+// The namespace must be one of the values returned by the
+// `namespaces`
+// endpoint, while the type can be a string of any characters except for
+// the
+// forward slash (`/`) up to 100 characters in length.
+//
+// Attachment data can be up to 1024 bytes long.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsAttachmentsService) Create(beaconName string, beaconattachment *BeaconAttachment) *BeaconsAttachmentsCreateCall {
c := &BeaconsAttachmentsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2558,8 +2991,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the project the attachment will belong to. If the project id is not
-// specified then the project making the request is used.
+// the project the attachment will belong to. If
+// the project id is not specified then the project making the
+// request
+// is used.
func (c *BeaconsAttachmentsCreateCall) ProjectId(projectId string) *BeaconsAttachmentsCreateCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2652,7 +3087,8 @@
}
return ret, nil
// {
- // "description": "Associates the given data with the specified beacon. Attachment data must contain two parts: \n- A namespaced type. \n- The actual attachment data itself. The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length. Attachment data can be up to 1024 bytes long. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
// "httpMethod": "POST",
// "id": "proximitybeacon.beacons.attachments.create",
// "parameterOrder": [
@@ -2660,14 +3096,14 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Beacon on which the attachment should be created. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -2697,12 +3133,19 @@
}
// Delete: Deletes the specified attachment for the given beacon. Each
-// attachment has a unique attachment name (`attachmentName`) which is
-// returned when you fetch the attachment data via this API. You specify
-// this with the delete request to control which attachment is removed.
-// This operation cannot be undone. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **Is owner** or **Can edit** permissions in the
+// attachment has
+// a unique attachment name (`attachmentName`) which is returned when
+// you
+// fetch the attachment data via this API. You specify this with the
+// delete
+// request to control which attachment is removed. This operation cannot
+// be
+// undone.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **Is owner** or **Can edit** permissions
+// in the
// Google Developers Console project.
func (r *BeaconsAttachmentsService) Delete(attachmentName string) *BeaconsAttachmentsDeleteCall {
c := &BeaconsAttachmentsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2711,8 +3154,8 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the attachment to delete. If not provided, the project that is making
-// the request is used.
+// the attachment to delete. If not provided, the project
+// that is making the request is used.
func (c *BeaconsAttachmentsDeleteCall) ProjectId(projectId string) *BeaconsAttachmentsDeleteCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2800,7 +3243,8 @@
}
return ret, nil
// {
- // "description": "Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}",
// "httpMethod": "DELETE",
// "id": "proximitybeacon.beacons.attachments.delete",
// "parameterOrder": [
@@ -2808,14 +3252,14 @@
// ],
// "parameters": {
// "attachmentName": {
- // "description": "The attachment name (`attachmentName`) of the attachment to remove. For example: `beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For Eddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the beacon's current EID, or its \"stable\" Eddystone-UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*/attachments/[^/]*$",
+ // "pattern": "^beacons/[^/]+/attachments/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the attachment to delete. If not provided, the project that is making the request is used. Optional.",
+ // "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.",
// "location": "query",
// "type": "string"
// }
@@ -2843,13 +3287,20 @@
}
// List: Returns the attachments for the specified beacon that match the
-// specified namespaced-type pattern. To control which namespaced types
-// are returned, you add the `namespacedType` query parameter to the
-// request. You must either use `*/*`, to return all attachments, or the
-// namespace must be one of the ones returned from the `namespaces`
-// endpoint. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **viewer**, **Is owner** or **Can edit**
+// specified
+// namespaced-type pattern.
+//
+// To control which namespaced types are returned, you add
+// the
+// `namespacedType` query parameter to the request. You must either
+// use
+// `*/*`, to return all attachments, or the namespace must be one of
+// the ones returned from the `namespaces` endpoint.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **viewer**, **Is owner** or **Can
+// edit**
// permissions in the Google Developers Console project.
func (r *BeaconsAttachmentsService) List(beaconName string) *BeaconsAttachmentsListCall {
c := &BeaconsAttachmentsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -2859,19 +3310,22 @@
// NamespacedType sets the optional parameter "namespacedType":
// Specifies the namespace and type of attachment to include in response
-// in namespace/type format. Accepts `*/*` to specify "all types in all
-// namespaces".
+// in
+// <var>namespace/type</var> format. Accepts `*/*` to specify
+// "all types in all namespaces".
func (c *BeaconsAttachmentsListCall) NamespacedType(namespacedType string) *BeaconsAttachmentsListCall {
c.urlParams_.Set("namespacedType", namespacedType)
return c
}
// ProjectId sets the optional parameter "projectId": The project id to
-// list beacon attachments under. This field can be used when "*" is
-// specified to mean all attachment namespaces. Projects may have
-// multiple attachments with multiple namespaces. If "*" is specified
-// and the projectId string is empty, then the project making the
-// request is used.
+// list beacon attachments under. This field can be
+// used when "*" is specified to mean all attachment namespaces.
+// Projects
+// may have multiple attachments with multiple namespaces. If "*"
+// is
+// specified and the projectId string is empty, then the project
+// making the request is used.
func (c *BeaconsAttachmentsListCall) ProjectId(projectId string) *BeaconsAttachmentsListCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -2972,7 +3426,8 @@
}
return ret, nil
// {
- // "description": "Returns the attachments for the specified beacon that match the specified namespaced-type pattern. To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}/attachments",
// "httpMethod": "GET",
// "id": "proximitybeacon.beacons.attachments.list",
// "parameterOrder": [
@@ -2980,19 +3435,19 @@
// ],
// "parameters": {
// "beaconName": {
- // "description": "Beacon whose attachments should be fetched. A beacon name has the format \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's \"stable\" UID. Required.",
+ // "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.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "namespacedType": {
- // "description": "Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts `*/*` to specify \"all types in all namespaces\".",
+ // "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\".",
// "location": "query",
// "type": "string"
// },
// "projectId": {
- // "description": "The project id to list beacon attachments under. This field can be used when \"*\" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If \"*\" is specified and the projectId string is empty, then the project making the request is used. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -3020,11 +3475,15 @@
}
// List: List the diagnostics for a single beacon. You can also list
-// diagnostics for all the beacons owned by your Google Developers
-// Console project by using the beacon name `beacons/-`. Authenticate
-// using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **viewer**, **Is owner** or **Can edit**
+// diagnostics for
+// all the beacons owned by your Google Developers Console project by
+// using
+// the beacon name `beacons/-`.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **viewer**, **Is owner** or **Can
+// edit**
// permissions in the Google Developers Console project.
func (r *BeaconsDiagnosticsService) List(beaconName string) *BeaconsDiagnosticsListCall {
c := &BeaconsDiagnosticsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -3033,8 +3492,8 @@
}
// AlertFilter sets the optional parameter "alertFilter": Requests only
-// beacons that have the given alert. For example, to find beacons that
-// have low batteries use `alert_filter=LOW_BATTERY`.
+// beacons that have the given alert. For example, to find
+// beacons that have low batteries use `alert_filter=LOW_BATTERY`.
//
// Possible values:
// "ALERT_UNSPECIFIED"
@@ -3046,24 +3505,26 @@
}
// PageSize sets the optional parameter "pageSize": Specifies the
-// maximum number of results to return. Defaults to 10. Maximum 1000.
+// maximum number of results to return. Defaults to
+// 10. Maximum 1000.
func (c *BeaconsDiagnosticsListCall) PageSize(pageSize int64) *BeaconsDiagnosticsListCall {
c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
return c
}
// PageToken sets the optional parameter "pageToken": Requests results
-// that occur after the `page_token`, obtained from the response to a
-// previous request.
+// that occur after the `page_token`, obtained from the
+// response to a previous request.
func (c *BeaconsDiagnosticsListCall) PageToken(pageToken string) *BeaconsDiagnosticsListCall {
c.urlParams_.Set("pageToken", pageToken)
return c
}
// ProjectId sets the optional parameter "projectId": Requests only
-// diagnostic records for the given project id. If not set, then the
-// project making the request will be used for looking up diagnostic
-// records.
+// diagnostic records for the given project id. If not set,
+// then the project making the request will be used for looking
+// up
+// diagnostic records.
func (c *BeaconsDiagnosticsListCall) ProjectId(projectId string) *BeaconsDiagnosticsListCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -3164,7 +3625,8 @@
}
return ret, nil
// {
- // "description": "List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics",
// "httpMethod": "GET",
// "id": "proximitybeacon.beacons.diagnostics.list",
// "parameterOrder": [
@@ -3172,7 +3634,7 @@
// ],
// "parameters": {
// "alertFilter": {
- // "description": "Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.",
+ // "description": "Requests only beacons that have the given alert. For example, to find\nbeacons that have low batteries use `alert_filter=LOW_BATTERY`.",
// "enum": [
// "ALERT_UNSPECIFIED",
// "WRONG_LOCATION",
@@ -3184,23 +3646,23 @@
// "beaconName": {
// "description": "Beacon that the diagnostics are for.",
// "location": "path",
- // "pattern": "^beacons/[^/]*$",
+ // "pattern": "^beacons/[^/]+$",
// "required": true,
// "type": "string"
// },
// "pageSize": {
- // "description": "Specifies the maximum number of results to return. Defaults to 10. Maximum 1000. Optional.",
+ // "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.",
// "format": "int32",
// "location": "query",
// "type": "integer"
// },
// "pageToken": {
- // "description": "Requests results that occur after the `page_token`, obtained from the response to a previous request. Optional.",
+ // "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.",
// "location": "query",
// "type": "string"
// },
// "projectId": {
- // "description": "Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -3248,11 +3710,16 @@
}
// List: Lists all attachment namespaces owned by your Google Developers
-// Console project. Attachment data associated with a beacon must
-// include a namespaced type, and the namespace must be owned by your
-// project. Authenticate using an [OAuth access
-// token](https://developers.google.com/identity/protocols/OAuth2) from
-// a signed-in user with **viewer**, **Is owner** or **Can edit**
+// Console
+// project. Attachment data associated with a beacon must include
+// a
+// namespaced type, and the namespace must be owned by your
+// project.
+//
+// Authenticate using an [OAuth access
+// token](https://developers.google.com/identity/protocols/OAuth2)
+// from a signed-in user with **viewer**, **Is owner** or **Can
+// edit**
// permissions in the Google Developers Console project.
func (r *NamespacesService) List() *NamespacesListCall {
c := &NamespacesListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
@@ -3358,12 +3825,14 @@
}
return ret, nil
// {
- // "description": "Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.",
+ // "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.",
+ // "flatPath": "v1beta1/namespaces",
// "httpMethod": "GET",
// "id": "proximitybeacon.namespaces.list",
+ // "parameterOrder": [],
// "parameters": {
// "projectId": {
- // "description": "The project id to list namespaces under. Optional.",
+ // "description": "The project id to list namespaces under.\nOptional.",
// "location": "query",
// "type": "string"
// }
@@ -3391,7 +3860,8 @@
}
// Update: Updates the information about the specified namespace. Only
-// the namespace visibility can be updated.
+// the namespace
+// visibility can be updated.
func (r *NamespacesService) Update(namespaceName string, namespace *Namespace) *NamespacesUpdateCall {
c := &NamespacesUpdateCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.namespaceName = namespaceName
@@ -3400,9 +3870,10 @@
}
// ProjectId sets the optional parameter "projectId": The project id of
-// the namespace to update. If the project id is not specified then the
-// project making the request is used. The project id must match the
-// project that owns the beacon.
+// the namespace to update. If the project id is not
+// specified then the project making the request is used. The project
+// id
+// must match the project that owns the beacon.
func (c *NamespacesUpdateCall) ProjectId(projectId string) *NamespacesUpdateCall {
c.urlParams_.Set("projectId", projectId)
return c
@@ -3495,7 +3966,8 @@
}
return ret, nil
// {
- // "description": "Updates the information about the specified namespace. Only the namespace visibility can be updated.",
+ // "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.",
+ // "flatPath": "v1beta1/namespaces/{namespacesId}",
// "httpMethod": "PUT",
// "id": "proximitybeacon.namespaces.update",
// "parameterOrder": [
@@ -3503,14 +3975,14 @@
// ],
// "parameters": {
// "namespaceName": {
- // "description": "Resource name of this namespace. Namespaces names have the format: namespaces/namespace.",
+ // "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.",
// "location": "path",
- // "pattern": "^namespaces/[^/]*$",
+ // "pattern": "^namespaces/[^/]+$",
// "required": true,
// "type": "string"
// },
// "projectId": {
- // "description": "The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.",
+ // "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.",
// "location": "query",
// "type": "string"
// }
@@ -3540,12 +4012,18 @@
}
// GetEidparams: Gets the Proximity Beacon API's current public key and
-// associated parameters used to initiate the Diffie-Hellman key
-// exchange required to register a beacon that broadcasts the
-// Eddystone-EID format. This key changes periodically; clients may
-// cache it and re-use the same public key to provision and register
-// multiple beacons. However, clients should be prepared to refresh this
-// key when they encounter an error registering an Eddystone-EID beacon.
+// associated
+// parameters used to initiate the Diffie-Hellman key exchange required
+// to
+// register a beacon that broadcasts the Eddystone-EID format. This
+// key
+// changes periodically; clients may cache it and re-use the same public
+// key
+// to provision and register multiple beacons. However, clients should
+// be
+// prepared to refresh this key when they encounter an error registering
+// an
+// Eddystone-EID beacon.
func (r *V1beta1Service) GetEidparams() *V1beta1GetEidparamsCall {
c := &V1beta1GetEidparamsCall{s: r.s, urlParams_: make(gensupport.URLParams)}
return c
@@ -3643,9 +4121,12 @@
}
return ret, nil
// {
- // "description": "Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.",
+ // "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.",
+ // "flatPath": "v1beta1/eidparams",
// "httpMethod": "GET",
// "id": "proximitybeacon.getEidparams",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v1beta1/eidparams",
// "response": {
// "$ref": "EphemeralIdRegistrationParams"
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json
index ff58f3d..acd6989 100644
--- a/pubsub/v1/pubsub-api.json
+++ b/pubsub/v1/pubsub-api.json
@@ -1,405 +1,29 @@
{
+ "name": "pubsub",
+ "batchPath": "batch",
+ "revision": "20170214",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1",
+ "title": "Google Cloud Pub/Sub API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
- "topics": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "topic": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1/{+topic}",
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/topics",
- "path": "v1/{+project}/topics",
- "id": "pubsub.projects.topics.list",
- "description": "Lists matching topics.",
- "parameterOrder": [
- "project"
- ],
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "httpMethod": "GET",
- "parameters": {
- "pageToken": {
- "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
- "type": "string",
- "location": "query"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
- },
- "create": {
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name.",
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "path": "v1/{+name}",
- "id": "pubsub.projects.topics.create"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
- "id": "pubsub.projects.topics.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "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",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "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.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1/{+topic}"
- },
- "publish": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "topic": {
- "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
- "path": "v1/{+topic}:publish",
- "id": "pubsub.projects.topics.publish",
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.",
- "request": {
- "$ref": "PublishRequest"
- },
- "response": {
- "$ref": "PublishResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "httpMethod": "POST"
- },
- "testIamPermissions": {
- "id": "pubsub.projects.topics.testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "request": {
- "$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
- }
- },
- "resources": {
- "subscriptions": {
- "methods": {
- "list": {
- "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions",
- "id": "pubsub.projects.topics.subscriptions.list",
- "path": "v1/{+topic}/subscriptions",
- "description": "Lists the name of the subscriptions for this topic.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicSubscriptionsResponse"
- },
- "parameterOrder": [
- "topic"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data."
- },
- "pageSize": {
- "description": "Maximum number of subscription names to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "topic": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path",
- "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`."
- }
- }
- }
- }
- }
- }
- },
"subscriptions": {
"methods": {
- "acknowledge": {
- "id": "pubsub.projects.subscriptions.acknowledge",
- "path": "v1/{+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"
- },
- "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.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge"
- },
- "modifyAckDeadline": {
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "path": "v1/{+subscription}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline"
- },
- "getIamPolicy": {
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
- },
- "get": {
- "description": "Gets the configuration details of a subscription.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.get",
- "path": "v1/{+subscription}"
- },
"testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
@@ -409,86 +33,31 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
- "id": "pubsub.projects.subscriptions.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.subscriptions.testIamPermissions",
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
- },
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning."
- },
- "modifyPushConfig": {
- "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}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "path": "v1/{+subscription}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.",
- "request": {
- "$ref": "ModifyPushConfigRequest"
}
},
- "delete": {
- "description": "Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "subscription"
- ],
+ "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"
},
- "parameters": {
- "subscription": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.delete",
- "path": "v1/{+subscription}"
- },
- "pull": {
- "httpMethod": "POST",
"parameterOrder": [
"subscription"
],
- "response": {
- "$ref": "PullResponse"
- },
+ "httpMethod": "POST",
"parameters": {
"subscription": {
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path",
- "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
"required": true,
"type": "string"
}
@@ -497,27 +66,77 @@
"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",
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
+ "path": "v1/{+subscription}:modifyPushConfig",
+ "id": "pubsub.projects.subscriptions.modifyPushConfig"
+ },
+ "pull": {
"path": "v1/{+subscription}:pull",
+ "id": "pubsub.projects.subscriptions.pull",
+ "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
"request": {
"$ref": "PullRequest"
},
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription."
- },
- "list": {
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
"response": {
- "$ref": "ListSubscriptionsResponse"
+ "$ref": "PullResponse"
},
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull"
+ },
+ "delete": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete",
+ "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"
+ },
+ "list": {
+ "path": "v1/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list",
+ "description": "Lists matching subscriptions.",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "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",
@@ -530,25 +149,55 @@
"location": "query"
},
"project": {
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+$",
"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 subscriptions belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/subscriptions",
- "path": "v1/{+project}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "description": "Lists matching subscriptions."
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions"
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
},
"create": {
"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"
},
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.",
"httpMethod": "PUT",
"parameterOrder": [
"name"
@@ -556,113 +205,139 @@
"response": {
"$ref": "Subscription"
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"parameters": {
"name": {
- "location": "path",
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
"required": true,
"type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
- },
- "setIamPolicy": {
- "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
"location": "path"
}
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}"
+ },
+ "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.",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "httpMethod": "GET",
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy"
+ },
+ "modifyAckDeadline": {
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "path": "v1/{+subscription}:modifyAckDeadline",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline"
+ },
+ "acknowledge": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "subscription": {
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "path": "v1/{+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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "Empty"
}
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "parameters": {
+ "subscription": {
+ "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1/{+subscription}",
+ "description": "Gets the configuration details of a subscription."
}
}
},
"snapshots": {
"methods": {
- "setIamPolicy": {
- "path": "v1/{+resource}:setIamPolicy",
- "id": "pubsub.projects.snapshots.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy"
- },
- "testIamPermissions": {
- "id": "pubsub.projects.snapshots.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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/snapshots/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions"
- },
"getIamPolicy": {
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.snapshots.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
"response": {
"$ref": "Policy"
},
@@ -676,17 +351,350 @@
],
"parameters": {
"resource": {
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/snapshots/[^/]+$"
+ "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy",
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}: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": {
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy",
+ "id": "pubsub.projects.snapshots.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "testIamPermissions": {
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/snapshots/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.snapshots.testIamPermissions",
+ "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."
+ }
+ }
+ },
+ "topics": {
+ "methods": {
+ "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"
+ },
+ "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.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish",
+ "id": "pubsub.projects.topics.publish",
+ "path": "v1/{+topic}:publish"
+ },
+ "testIamPermissions": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}",
+ "path": "v1/{+topic}",
+ "id": "pubsub.projects.topics.delete",
+ "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`."
+ },
+ "list": {
+ "description": "Lists matching topics.",
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics",
+ "path": "v1/{+project}/topics",
+ "id": "pubsub.projects.topics.list"
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy"
+ },
+ "create": {
+ "path": "v1/{+name}",
+ "id": "pubsub.projects.topics.create",
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ },
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}"
+ },
+ "getIamPolicy": {
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
+ "id": "pubsub.projects.topics.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
- "id": "pubsub.projects.snapshots.getIamPolicy",
- "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ "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"
+ }
+ },
+ "get": {
+ "path": "v1/{+topic}",
+ "id": "pubsub.projects.topics.get",
+ "description": "Gets the configuration of a topic.",
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Topic"
+ },
+ "parameters": {
+ "topic": {
+ "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1/projects/{projectsId}/topics/{topicsId}"
+ }
+ },
+ "resources": {
+ "subscriptions": {
+ "methods": {
+ "list": {
+ "description": "Lists the name of the subscriptions for this topic.",
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
+ "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": {
+ "description": "Maximum number of subscription names to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "topic": {
+ "description": "The name of the topic that subscriptions are attached to.\nFormat is `projects/{project}/topics/{topic}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$",
+ "location": "path"
+ }
+ },
+ "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"
+ }
+ }
}
}
}
@@ -694,33 +702,50 @@
}
},
"parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "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"
},
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
+ "pp": {
+ "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
"location": "query"
},
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
@@ -730,10 +755,20 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format."
+ ]
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
},
"alt": {
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
@@ -741,197 +776,33 @@
"media",
"proto"
],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
+ "type": "string"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
},
"key": {
"location": "query",
"description": "API key. Your API 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": {
- "type": "boolean",
- "default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth 2.0 token for the current user."
}
},
"schemas": {
- "ListSubscriptionsResponse": {
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The subscriptions that match the request.",
- "type": "array",
- "items": {
- "$ref": "Subscription"
- }
- }
- },
- "id": "ListSubscriptionsResponse",
- "description": "Response for the `ListSubscriptions` method.",
- "type": "object"
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- }
- },
- "id": "PublishRequest"
- },
- "PublishResponse": {
- "description": "Response for the `Publish` method.",
- "type": "object",
- "properties": {
- "messageIds": {
- "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "PublishResponse"
- },
- "Subscription": {
- "properties": {
- "ackDeadlineSeconds": {
- "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
- "type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
- "type": "string"
- },
- "pushConfig": {
- "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.",
- "$ref": "PushConfig"
- }
- },
- "id": "Subscription",
- "description": "A subscription resource.",
- "type": "object"
- },
- "TestIamPermissionsRequest": {
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object"
- },
- "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": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- },
- "id": "Policy"
- },
- "ModifyAckDeadlineRequest": {
- "type": "object",
- "properties": {
- "ackIds": {
- "description": "List of acknowledgment IDs.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "ackDeadlineSeconds": {
- "type": "integer",
- "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
- "format": "int32"
- }
- },
- "id": "ModifyAckDeadlineRequest",
- "description": "Request for the ModifyAckDeadline method."
- },
"SetIamPolicyRequest": {
"id": "SetIamPolicyRequest",
"description": "Request message for `SetIamPolicy` method.",
"type": "object",
"properties": {
"policy": {
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
- "$ref": "Policy"
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
}
},
"ModifyPushConfigRequest": {
+ "id": "ModifyPushConfigRequest",
"description": "Request for the ModifyPushConfig method.",
"type": "object",
"properties": {
@@ -939,10 +810,12 @@
"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"
+ }
},
"PubsubMessage": {
+ "id": "PubsubMessage",
+ "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
+ "type": "object",
"properties": {
"attributes": {
"additionalProperties": {
@@ -952,8 +825,8 @@
"type": "object"
},
"messageId": {
- "type": "string",
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call."
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
},
"publishTime": {
"description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
@@ -965,12 +838,10 @@
"format": "byte",
"type": "string"
}
- },
- "id": "PubsubMessage",
- "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
- "type": "object"
+ }
},
"Binding": {
+ "description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"members": {
@@ -985,10 +856,11 @@
"type": "string"
}
},
- "id": "Binding",
- "description": "Associates `members` with a `role`."
+ "id": "Binding"
},
"AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "type": "object",
"properties": {
"ackIds": {
"description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
@@ -998,18 +870,15 @@
}
}
},
- "id": "AcknowledgeRequest",
- "description": "Request for the Acknowledge method.",
- "type": "object"
+ "id": "AcknowledgeRequest"
},
"Empty": {
+ "id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object",
- "properties": {},
- "id": "Empty"
+ "properties": {}
},
"ListTopicsResponse": {
- "id": "ListTopicsResponse",
"description": "Response for the `ListTopics` method.",
"type": "object",
"properties": {
@@ -1024,27 +893,29 @@
"description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
"type": "string"
}
- }
+ },
+ "id": "ListTopicsResponse"
},
"ListTopicSubscriptionsResponse": {
+ "id": "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.",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "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"
}
- },
- "id": "ListTopicSubscriptionsResponse",
- "description": "Response for the `ListTopicSubscriptions` method."
+ }
},
"PullResponse": {
+ "id": "PullResponse",
"description": "Response for the `Pull` method.",
"type": "object",
"properties": {
@@ -1055,8 +926,7 @@
"$ref": "ReceivedMessage"
}
}
- },
- "id": "PullResponse"
+ }
},
"ReceivedMessage": {
"description": "A message and its corresponding acknowledgment ID.",
@@ -1092,18 +962,18 @@
"id": "PushConfig"
},
"TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed."
+ }
}
},
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
+ "id": "TestIamPermissionsResponse"
},
"PullRequest": {
"description": "Request for the `Pull` method.",
@@ -1120,6 +990,144 @@
}
},
"id": "PullRequest"
+ },
+ "ListSubscriptionsResponse": {
+ "id": "ListSubscriptionsResponse",
+ "description": "Response for the `ListSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "subscriptions": {
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "PublishRequest": {
+ "id": "PublishRequest",
+ "description": "Request for the Publish method.",
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ }
+ }
+ },
+ "PublishResponse": {
+ "description": "Response for the `Publish` method.",
+ "type": "object",
+ "properties": {
+ "messageIds": {
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "PublishResponse"
+ },
+ "Subscription": {
+ "description": "A subscription resource.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "$ref": "PushConfig",
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods."
+ },
+ "ackDeadlineSeconds": {
+ "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\npull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
+ "type": "string"
+ }
+ },
+ "id": "Subscription"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Policy": {
+ "id": "Policy",
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ },
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ }
+ }
+ },
+ "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": {
+ "id": "ModifyAckDeadlineRequest",
+ "description": "Request for the ModifyAckDeadline method.",
+ "type": "object",
+ "properties": {
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "ackIds": {
+ "description": "List of acknowledgment IDs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
}
},
"icons": {
@@ -1147,13 +1155,5 @@
"servicePath": "",
"rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
- "ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20170214",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1",
- "title": "Google Cloud Pub/Sub API",
- "ownerName": "Google",
- "discoveryVersion": "v1"
+ "ownerDomain": "google.com"
}
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json
index d04131f..c57abf6 100644
--- a/pubsub/v1beta1a/pubsub-api.json
+++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,27 +1,32 @@
{
+ "batchPath": "batch",
+ "revision": "20170214",
+ "documentationLink": "https://cloud.google.com/pubsub/docs",
+ "id": "pubsub:v1beta1a",
+ "title": "Google Cloud Pub/Sub API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"subscriptions": {
"methods": {
"modifyAckDeadline": {
+ "description": "Modifies the Ack deadline for a message received from a pull request.",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
"httpMethod": "POST",
"parameterOrder": [],
"response": {
"$ref": "Empty"
},
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {},
"flatPath": "v1beta1a/subscriptions/modifyAckDeadline",
"id": "pubsub.subscriptions.modifyAckDeadline",
- "path": "v1beta1a/subscriptions/modifyAckDeadline",
- "request": {
- "$ref": "ModifyAckDeadlineRequest"
- },
- "description": "Modifies the Ack deadline for a message received from a pull request."
+ "path": "v1beta1a/subscriptions/modifyAckDeadline"
},
"acknowledge": {
"httpMethod": "POST",
@@ -62,8 +67,6 @@
"path": "v1beta1a/subscriptions/pullBatch"
},
"get": {
- "path": "v1beta1a/subscriptions/{+subscription}",
- "id": "pubsub.subscriptions.get",
"description": "Gets the configuration details of a subscription.",
"response": {
"$ref": "Subscription"
@@ -74,20 +77,29 @@
"httpMethod": "GET",
"parameters": {
"subscription": {
- "pattern": "^.+$",
- "location": "path",
"description": "The name of the subscription to get.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^.+$",
+ "location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "flatPath": "v1beta1a/subscriptions/{subscriptionsId}"
+ "flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
+ "path": "v1beta1a/subscriptions/{+subscription}",
+ "id": "pubsub.subscriptions.get"
},
"modifyPushConfig": {
+ "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
+ "id": "pubsub.subscriptions.modifyPushConfig",
+ "path": "v1beta1a/subscriptions/modifyPushConfig",
+ "request": {
+ "$ref": "ModifyPushConfigRequest"
+ },
+ "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.",
"httpMethod": "POST",
"parameterOrder": [],
"response": {
@@ -97,33 +109,26 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/subscriptions/modifyPushConfig",
- "id": "pubsub.subscriptions.modifyPushConfig",
- "path": "v1beta1a/subscriptions/modifyPushConfig",
- "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."
+ ]
},
"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"
],
+ "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)."
+ "id": "pubsub.subscriptions.pull"
},
"delete": {
"description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.",
@@ -134,34 +139,35 @@
"response": {
"$ref": "Empty"
},
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {
- "subscription": {
- "required": true,
- "type": "string",
- "pattern": "^.+$",
- "location": "path",
- "description": "The subscription to delete."
- }
- },
"flatPath": "v1beta1a/subscriptions/{subscriptionsId}",
"id": "pubsub.subscriptions.delete",
"path": "v1beta1a/subscriptions/{+subscription}"
},
"list": {
- "parameterOrder": [],
- "httpMethod": "GET",
+ "description": "Lists matching subscriptions.",
"response": {
"$ref": "ListSubscriptionsResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"parameters": {
"pageToken": {
+ "location": "query",
"description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"query": {
"location": "query",
@@ -180,42 +186,41 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1beta1a/subscriptions",
- "id": "pubsub.subscriptions.list",
"path": "v1beta1a/subscriptions",
- "description": "Lists matching subscriptions."
+ "id": "pubsub.subscriptions.list"
},
"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"
},
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Subscription"
},
- "parameterOrder": [],
- "httpMethod": "POST",
+ "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
- "parameters": {},
- "flatPath": "v1beta1a/subscriptions"
+ "flatPath": "v1beta1a/subscriptions",
+ "id": "pubsub.subscriptions.create",
+ "path": "v1beta1a/subscriptions"
}
}
},
"topics": {
"methods": {
- "delete": {
- "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
- "httpMethod": "DELETE",
+ "get": {
+ "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.",
+ "response": {
+ "$ref": "Topic"
+ },
"parameterOrder": [
"topic"
],
- "response": {
- "$ref": "Empty"
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
@@ -223,46 +228,86 @@
"parameters": {
"topic": {
"location": "path",
+ "description": "The name of the topic to get.",
+ "required": true,
+ "type": "string",
+ "pattern": "^.+$"
+ }
+ },
+ "flatPath": "v1beta1a/topics/{topicsId}",
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.get"
+ },
+ "publish": {
+ "request": {
+ "$ref": "PublishRequest"
+ },
+ "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta1a/topics/publish",
+ "id": "pubsub.topics.publish",
+ "path": "v1beta1a/topics/publish"
+ },
+ "delete": {
+ "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "topic": {
+ "location": "path",
"description": "Name of the topic to delete.",
"required": true,
"type": "string",
"pattern": "^.+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.delete",
- "path": "v1beta1a/topics/{+topic}"
+ "path": "v1beta1a/topics/{+topic}",
+ "id": "pubsub.topics.delete"
},
"publishBatch": {
- "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
- "request": {
- "$ref": "PublishBatchRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
"response": {
"$ref": "PublishBatchResponse"
},
+ "parameterOrder": [],
+ "httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
"parameters": {},
"flatPath": "v1beta1a/topics/publishBatch",
+ "path": "v1beta1a/topics/publishBatch",
"id": "pubsub.topics.publishBatch",
- "path": "v1beta1a/topics/publishBatch"
+ "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.",
+ "request": {
+ "$ref": "PublishBatchRequest"
+ }
},
"list": {
- "description": "Lists matching topics.",
"httpMethod": "GET",
"response": {
"$ref": "ListTopicsResponse"
},
"parameterOrder": [],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"pageToken": {
"location": "query",
@@ -275,88 +320,48 @@
"type": "string"
},
"maxResults": {
- "location": "query",
"description": "Maximum number of topics to return.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1beta1a/topics",
"id": "pubsub.topics.list",
- "path": "v1beta1a/topics"
+ "path": "v1beta1a/topics",
+ "description": "Lists matching topics."
},
"create": {
+ "description": "Creates the given topic with the given name.",
+ "request": {
+ "$ref": "Topic"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Topic"
},
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
],
+ "parameters": {},
"flatPath": "v1beta1a/topics",
- "path": "v1beta1a/topics",
"id": "pubsub.topics.create",
- "request": {
- "$ref": "Topic"
- },
- "description": "Creates the given topic with the given name."
- },
- "get": {
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Topic"
- },
- "parameters": {
- "topic": {
- "location": "path",
- "description": "The name of the topic to get.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta1a/topics/{topicsId}",
- "id": "pubsub.topics.get",
- "path": "v1beta1a/topics/{+topic}",
- "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": {
- "flatPath": "v1beta1a/topics/publish",
- "path": "v1beta1a/topics/publish",
- "id": "pubsub.topics.publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds a message to the topic. Returns NOT_FOUND if the topic does not\nexist.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "parameters": {},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ]
+ "path": "v1beta1a/topics"
}
}
}
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
"location": "query",
@@ -365,9 +370,9 @@
"default": "true"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"uploadType": {
"location": "query",
@@ -393,6 +398,8 @@
"type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -404,18 +411,16 @@
"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",
+ "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": {
@@ -424,23 +429,233 @@
"location": "query"
},
"pp": {
+ "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
+ "Topic": {
+ "description": "A topic resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the topic.",
+ "type": "string"
+ }
+ },
+ "id": "Topic"
+ },
+ "Label": {
+ "description": "A key-value pair applied to a given object.",
+ "type": "object",
+ "properties": {
+ "strValue": {
+ "description": "A string value.",
+ "type": "string"
+ },
+ "numValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "key": {
+ "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
+ "type": "string"
+ }
+ },
+ "id": "Label"
+ },
+ "ModifyAckDeadlineRequest": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "subscription": {
+ "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
+ "type": "string"
+ },
+ "ackId": {
+ "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.",
+ "type": "string"
+ },
+ "ackDeadlineSeconds": {
+ "description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ModifyAckDeadlineRequest"
+ },
+ "PullBatchRequest": {
+ "description": "Request for the PullBatch method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "type": "string"
+ },
+ "returnImmediately": {
+ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
+ "type": "boolean"
+ },
+ "maxEvents": {
+ "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PullBatchRequest"
+ },
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.",
+ "$ref": "PushConfig"
+ },
+ "subscription": {
+ "description": "The name of the subscription.",
+ "type": "string"
+ }
+ },
+ "id": "ModifyPushConfigRequest"
+ },
+ "PubsubMessage": {
+ "description": "A message data and its labels.",
+ "type": "object",
+ "properties": {
+ "data": {
+ "description": "The message payload.",
+ "format": "byte",
+ "type": "string"
+ },
+ "messageId": {
+ "description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.",
+ "type": "string"
+ },
+ "label": {
+ "description": "Optional list of labels for this message. Keys in this collection must\nbe unique.",
+ "type": "array",
+ "items": {
+ "$ref": "Label"
+ }
+ },
+ "publishTime": {
+ "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "id": "PubsubMessage"
+ },
+ "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"
+ },
+ "PullBatchResponse": {
+ "description": "Response for the PullBatch method.",
+ "type": "object",
+ "properties": {
+ "pullResponses": {
+ "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
+ "type": "array",
+ "items": {
+ "$ref": "PullResponse"
+ }
+ }
+ },
+ "id": "PullBatchResponse"
+ },
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "type": "object",
+ "properties": {
+ "subscription": {
+ "description": "The subscription whose message is being acknowledged.",
+ "type": "string"
+ },
+ "ackId": {
+ "description": "The acknowledgment ID for the message being acknowledged. This was\nreturned by the Pub/Sub system in the Pull response.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AcknowledgeRequest"
+ },
+ "PublishBatchRequest": {
+ "description": "Request for the PublishBatch method.",
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ },
+ "topic": {
+ "description": "The messages in the request will be published on this topic.",
+ "type": "string"
+ }
+ },
+ "id": "PublishBatchRequest"
+ },
+ "ListTopicsResponse": {
+ "description": "Response for the ListTopics method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
+ "type": "string"
+ },
+ "topic": {
+ "description": "The resulting topics.",
+ "type": "array",
+ "items": {
+ "$ref": "Topic"
+ }
+ }
+ },
+ "id": "ListTopicsResponse"
+ },
+ "PullResponse": {
+ "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
+ "type": "object",
+ "properties": {
+ "ackId": {
+ "description": "This ID must be used to acknowledge the received event or message.",
+ "type": "string"
+ },
+ "pubsubEvent": {
+ "$ref": "PubsubEvent",
+ "description": "A pubsub message or truncation event."
+ }
+ },
+ "id": "PullResponse"
+ },
"PushConfig": {
"description": "Configuration for a push delivery endpoint.",
"type": "object",
@@ -517,37 +732,14 @@
"type": "string"
},
"message": {
- "$ref": "PubsubMessage",
- "description": "The message to publish."
+ "description": "The message to publish.",
+ "$ref": "PubsubMessage"
}
},
"id": "PublishRequest"
},
- "Subscription": {
- "description": "A subscription resource.",
- "type": "object",
- "properties": {
- "ackDeadlineSeconds": {
- "description": "For either push or pull delivery, the value is the maximum time after a\nsubscriber receives a message before the subscriber should acknowledge or\nNack the message. If the Ack deadline for a message passes without an\nAck or a Nack, the Pub/Sub system will eventually redeliver the message.\nIf a subscriber acknowledges after the deadline, the Pub/Sub system may\naccept the Ack, but it is possible that the message has been already\ndelivered again. Multiple Acks to the message are allowed and will\nsucceed.\n\nFor push delivery, this value is used to set the request timeout for\nthe call to the push endpoint.\n\nFor pull delivery, this value is used as the initial value for the Ack\ndeadline. It may be overridden for each message using its corresponding\nack_id with \u003ccode\u003eModifyAckDeadline\u003c/code\u003e.\nWhile a message is outstanding (i.e. it has been delivered to a pull\nsubscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub\nsystem will not deliver that message to another pull subscriber\n(on a best-effort basis).",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "Name of the subscription.",
- "type": "string"
- },
- "topic": {
- "description": "The name of the topic from which this subscription is receiving messages.",
- "type": "string"
- },
- "pushConfig": {
- "description": "If push delivery is used with this subscription, this field is\nused to configure it.",
- "$ref": "PushConfig"
- }
- },
- "id": "Subscription"
- },
"PublishBatchResponse": {
+ "description": "Response for the PublishBatch method.",
"type": "object",
"properties": {
"messageIds": {
@@ -558,250 +750,58 @@
}
}
},
- "id": "PublishBatchResponse",
- "description": "Response for the PublishBatch method."
+ "id": "PublishBatchResponse"
},
- "Topic": {
- "properties": {
- "name": {
- "description": "Name of the topic.",
- "type": "string"
- }
- },
- "id": "Topic",
- "description": "A topic resource.",
- "type": "object"
- },
- "Label": {
- "description": "A key-value pair applied to a given object.",
+ "Subscription": {
+ "description": "A subscription resource.",
"type": "object",
"properties": {
- "strValue": {
- "description": "A string value.",
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.",
"type": "string"
},
- "numValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "key": {
- "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe",
- "type": "string"
- }
- },
- "id": "Label"
- },
- "ModifyAckDeadlineRequest": {
- "description": "Request for the ModifyAckDeadline method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.",
- "type": "string"
- },
- "ackId": {
- "type": "string",
- "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both."
+ "pushConfig": {
+ "description": "If push delivery is used with this subscription, this field is\nused to configure it.",
+ "$ref": "PushConfig"
},
"ackDeadlineSeconds": {
- "description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.",
+ "description": "For either push or pull delivery, the value is the maximum time after a\nsubscriber receives a message before the subscriber should acknowledge or\nNack the message. If the Ack deadline for a message passes without an\nAck or a Nack, the Pub/Sub system will eventually redeliver the message.\nIf a subscriber acknowledges after the deadline, the Pub/Sub system may\naccept the Ack, but it is possible that the message has been already\ndelivered again. Multiple Acks to the message are allowed and will\nsucceed.\n\nFor push delivery, this value is used to set the request timeout for\nthe call to the push endpoint.\n\nFor pull delivery, this value is used as the initial value for the Ack\ndeadline. It may be overridden for each message using its corresponding\nack_id with \u003ccode\u003eModifyAckDeadline\u003c/code\u003e.\nWhile a message is outstanding (i.e. it has been delivered to a pull\nsubscriber and the subscriber has not yet Acked or Nacked), the Pub/Sub\nsystem will not deliver that message to another pull subscriber\n(on a best-effort basis).",
"format": "int32",
"type": "integer"
},
- "ackIds": {
- "description": "List of acknowledgment IDs. Either this field or ack_id\nshould be populated, not both.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ModifyAckDeadlineRequest"
- },
- "PullBatchRequest": {
- "description": "Request for the PullBatch method.",
- "type": "object",
- "properties": {
- "subscription": {
- "description": "The subscription from which messages should be pulled.",
- "type": "string"
- },
- "returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
- "type": "boolean"
- },
- "maxEvents": {
- "type": "integer",
- "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.",
- "format": "int32"
- }
- },
- "id": "PullBatchRequest"
- },
- "PubsubMessage": {
- "description": "A message data and its labels.",
- "type": "object",
- "properties": {
- "data": {
- "description": "The message payload.",
- "format": "byte",
- "type": "string"
- },
- "messageId": {
- "description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.",
- "type": "string"
- },
- "label": {
- "description": "Optional list of labels for this message. Keys in this collection must\nbe unique.",
- "type": "array",
- "items": {
- "$ref": "Label"
- }
- },
- "publishTime": {
- "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.",
- "format": "int64",
+ "name": {
+ "description": "Name of the subscription.",
"type": "string"
}
},
- "id": "PubsubMessage"
- },
- "ModifyPushConfigRequest": {
- "description": "Request for the ModifyPushConfig method.",
- "type": "object",
- "properties": {
- "pushConfig": {
- "$ref": "PushConfig",
- "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription."
- },
- "subscription": {
- "description": "The name of the subscription.",
- "type": "string"
- }
- },
- "id": "ModifyPushConfigRequest"
- },
- "PullBatchResponse": {
- "type": "object",
- "properties": {
- "pullResponses": {
- "description": "Received Pub/Sub messages or status events. The Pub/Sub system will return\nzero messages if there are no more messages available in the backlog. The\nPub/Sub system may return fewer than the max_events requested even if\nthere are more messages available in the backlog.",
- "type": "array",
- "items": {
- "$ref": "PullResponse"
- }
- }
- },
- "id": "PullBatchResponse",
- "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": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The acknowledgment ID for the message being acknowledged. This was\nreturned by the Pub/Sub system in the Pull response."
- }
- },
- "id": "AcknowledgeRequest"
- },
- "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": {
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- },
- "topic": {
- "description": "The messages in the request will be published on this topic.",
- "type": "string"
- }
- },
- "id": "PublishBatchRequest",
- "description": "Request for the PublishBatch method."
- },
- "ListTopicsResponse": {
- "description": "Response for the ListTopics method.",
- "type": "object",
- "properties": {
- "topic": {
- "description": "The resulting topics.",
- "type": "array",
- "items": {
- "$ref": "Topic"
- }
- },
- "nextPageToken": {
- "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.",
- "type": "string"
- }
- },
- "id": "ListTopicsResponse"
- },
- "PullResponse": {
- "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.",
- "type": "object",
- "properties": {
- "ackId": {
- "description": "This ID must be used to acknowledge the received event or message.",
- "type": "string"
- },
- "pubsubEvent": {
- "$ref": "PubsubEvent",
- "description": "A pubsub message or truncation event."
- }
- },
- "id": "PullResponse"
+ "id": "Subscription"
}
},
- "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": "v1beta1a",
"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",
- "servicePath": "",
"rootUrl": "https://pubsub.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
- "name": "pubsub",
- "batchPath": "batch",
- "revision": "20170214",
- "documentationLink": "https://cloud.google.com/pubsub/docs",
- "id": "pubsub:v1beta1a",
- "title": "Google Cloud Pub/Sub API"
+ "name": "pubsub"
}
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json
index 757d820..b5bdd64 100644
--- a/pubsub/v1beta2/pubsub-api.json
+++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,132 +1,11 @@
{
- "discoveryVersion": "v1",
"ownerName": "Google",
+ "discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"topics": {
"methods": {
- "delete": {
- "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.",
- "httpMethod": "DELETE",
- "parameterOrder": [
- "topic"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "topic": {
- "description": "Name of the topic to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.delete",
- "path": "v1beta2/{+topic}"
- },
- "list": {
- "parameterOrder": [
- "project"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "ListTopicsResponse"
- },
- "parameters": {
- "pageSize": {
- "location": "query",
- "description": "Maximum number of topics to return.",
- "format": "int32",
- "type": "integer"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that topics belong to.",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/topics",
- "path": "v1beta2/{+project}/topics",
- "id": "pubsub.projects.topics.list",
- "description": "Lists matching topics."
- },
- "create": {
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "path": "v1beta2/{+name}",
- "id": "pubsub.projects.topics.create",
- "description": "Creates the given topic with the given name.",
- "request": {
- "$ref": "Topic"
- },
- "response": {
- "$ref": "Topic"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- }
- },
- "setIamPolicy": {
- "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.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/topics/[^/]+$"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
- "id": "pubsub.projects.topics.setIamPolicy",
- "path": "v1beta2/{+resource}: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"
- }
- },
"getIamPolicy": {
"response": {
"$ref": "Policy"
@@ -135,10 +14,6 @@
"resource"
],
"httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"parameters": {
"resource": {
"location": "path",
@@ -148,6 +23,10 @@
"pattern": "^projects/[^/]+/topics/[^/]+$"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy",
"path": "v1beta2/{+resource}:getIamPolicy",
"id": "pubsub.projects.topics.getIamPolicy",
@@ -155,13 +34,13 @@
},
"get": {
"description": "Gets the configuration of a topic.",
- "httpMethod": "GET",
- "parameterOrder": [
- "topic"
- ],
"response": {
"$ref": "Topic"
},
+ "parameterOrder": [
+ "topic"
+ ],
+ "httpMethod": "GET",
"parameters": {
"topic": {
"location": "path",
@@ -176,10 +55,14 @@
"https://www.googleapis.com/auth/pubsub"
],
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}",
- "id": "pubsub.projects.topics.get",
- "path": "v1beta2/{+topic}"
+ "path": "v1beta2/{+topic}",
+ "id": "pubsub.projects.topics.get"
},
"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.",
"response": {
"$ref": "PublishResponse"
},
@@ -202,19 +85,13 @@
],
"flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish",
"path": "v1beta2/{+topic}:publish",
- "id": "pubsub.projects.topics.publish",
- "request": {
- "$ref": "PublishRequest"
- },
- "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute."
+ "id": "pubsub.projects.topics.publish"
},
"testIamPermissions": {
- "path": "v1beta2/{+resource}:testIamPermissions",
- "id": "pubsub.projects.topics.testIamPermissions",
- "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
"$ref": "TestIamPermissionsRequest"
},
+ "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"
},
@@ -222,26 +99,150 @@
"resource"
],
"httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions",
+ "path": "v1beta2/{+resource}:testIamPermissions",
+ "id": "pubsub.projects.topics.testIamPermissions"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "topic"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
"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.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "topic": {
+ "description": "Name of the topic to delete.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/topics/[^/]+$",
"location": "path"
}
},
- "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions"
+ "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": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "project"
+ ],
+ "response": {
+ "$ref": "ListTopicsResponse"
+ },
+ "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",
+ "description": "Maximum number of topics to return.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that topics belong to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics",
+ "id": "pubsub.projects.topics.list",
+ "path": "v1beta2/{+project}/topics",
+ "description": "Lists matching topics."
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.topics.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "create": {
+ "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\"`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/topics/[^/]+$"
+ }
+ },
+ "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"
+ }
}
},
"resources": {
"subscriptions": {
"methods": {
"list": {
+ "description": "Lists the name of the subscriptions for this topic.",
"response": {
"$ref": "ListTopicSubscriptionsResponse"
},
@@ -275,8 +276,7 @@
},
"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."
+ "id": "pubsub.projects.topics.subscriptions.list"
}
}
}
@@ -284,116 +284,6 @@
},
"subscriptions": {
"methods": {
- "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"
- },
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription whose message is being acknowledged.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge"
- },
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "The name of the subscription."
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
- "id": "pubsub.projects.subscriptions.modifyAckDeadline",
- "path": "v1beta2/{+subscription}: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.",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "httpMethod": "GET",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
- "path": "v1beta2/{+resource}:getIamPolicy",
- "id": "pubsub.projects.subscriptions.getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "Subscription"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "GET",
- "parameters": {
- "subscription": {
- "description": "The name of the subscription to get.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.get",
- "description": "Gets the configuration details of a subscription."
- },
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.",
"request": {
@@ -412,11 +302,11 @@
],
"parameters": {
"resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy detail is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`."
+ "location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions",
@@ -424,6 +314,192 @@
"id": "pubsub.projects.subscriptions.testIamPermissions"
},
"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`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
+ "location": "path",
+ "description": "The name of the subscription.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "pull": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "subscription"
+ ],
+ "response": {
+ "$ref": "PullResponse"
+ },
+ "parameters": {
+ "subscription": {
+ "description": "The subscription from which messages should be pulled.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
+ "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."
+ },
+ "delete": {
+ "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "subscription": {
+ "description": "The subscription to delete.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+subscription}",
+ "id": "pubsub.projects.subscriptions.delete"
+ },
+ "list": {
+ "description": "Lists matching subscriptions.",
+ "response": {
+ "$ref": "ListSubscriptionsResponse"
+ },
+ "parameterOrder": [
+ "project"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Maximum number of subscriptions to return.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "project": {
+ "location": "path",
+ "description": "The name of the cloud project that subscriptions belong to.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
+ "path": "v1beta2/{+project}/subscriptions",
+ "id": "pubsub.projects.subscriptions.list"
+ },
+ "create": {
+ "response": {
+ "$ref": "Subscription"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
+ "path": "v1beta2/{+name}",
+ "id": "pubsub.projects.subscriptions.create",
+ "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name.",
+ "request": {
+ "$ref": "Subscription"
+ }
+ },
+ "setIamPolicy": {
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
+ "path": "v1beta2/{+resource}:setIamPolicy",
+ "id": "pubsub.projects.subscriptions.setIamPolicy"
+ },
+ "acknowledge": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge",
+ "id": "pubsub.projects.subscriptions.acknowledge",
+ "path": "v1beta2/{+subscription}:acknowledge",
+ "request": {
+ "$ref": "AcknowledgeRequest"
+ },
+ "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.",
"httpMethod": "POST",
"parameterOrder": [
"subscription"
@@ -433,6 +509,61 @@
},
"parameters": {
"subscription": {
+ "location": "path",
+ "description": "The subscription whose message is being acknowledged.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ]
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/pubsub"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy is being requested.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy",
+ "path": "v1beta2/{+resource}:getIamPolicy",
+ "id": "pubsub.projects.subscriptions.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset."
+ },
+ "modifyAckDeadline": {
+ "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline",
+ "path": "v1beta2/{+subscription}:modifyAckDeadline",
+ "id": "pubsub.projects.subscriptions.modifyAckDeadline",
+ "request": {
+ "$ref": "ModifyAckDeadlineRequest"
+ },
+ "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "subscription"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "subscription": {
"description": "The name of the subscription.",
"required": true,
"type": "string",
@@ -443,164 +574,33 @@
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig",
- "id": "pubsub.projects.subscriptions.modifyPushConfig",
- "path": "v1beta2/{+subscription}:modifyPushConfig",
- "request": {
- "$ref": "ModifyPushConfigRequest"
- },
- "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`."
- },
- "delete": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "parameters": {
- "subscription": {
- "description": "The subscription to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "path": "v1beta2/{+subscription}",
- "id": "pubsub.projects.subscriptions.delete",
- "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified."
- },
- "pull": {
- "parameters": {
- "subscription": {
- "location": "path",
- "description": "The subscription from which messages should be pulled.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull",
- "path": "v1beta2/{+subscription}:pull",
- "id": "pubsub.projects.subscriptions.pull",
- "request": {
- "$ref": "PullRequest"
- },
- "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.",
- "response": {
- "$ref": "PullResponse"
- },
- "parameterOrder": [
- "subscription"
- ],
- "httpMethod": "POST"
- },
- "list": {
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions",
- "id": "pubsub.projects.subscriptions.list",
- "path": "v1beta2/{+project}/subscriptions",
- "description": "Lists matching subscriptions.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListSubscriptionsResponse"
- },
- "parameterOrder": [
- "project"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.",
- "type": "string"
- },
- "pageSize": {
- "description": "Maximum number of subscriptions to return.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "project": {
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The name of the cloud project that subscriptions belong to.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
]
},
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
+ "get": {
+ "description": "Gets the configuration details of a subscription.",
+ "httpMethod": "GET",
"parameterOrder": [
- "resource"
+ "subscription"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "Subscription"
+ },
"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.\n`resource` is usually specified as a path. For example, a Project\nresource is specified as `projects/{project}`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/subscriptions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy",
- "path": "v1beta2/{+resource}:setIamPolicy",
- "id": "pubsub.projects.subscriptions.setIamPolicy",
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- }
- },
- "create": {
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Subscription"
- },
- "parameters": {
- "name": {
+ "subscription": {
"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\"`.",
+ "description": "The name of the subscription to get.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/subscriptions/[^/]+$"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/pubsub"
- ],
"flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}",
- "id": "pubsub.projects.subscriptions.create",
- "path": "v1beta2/{+name}",
- "request": {
- "$ref": "Subscription"
- },
- "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic. Note that\nfor REST API requests, you must specify a name."
+ "id": "pubsub.projects.subscriptions.get",
+ "path": "v1beta2/{+subscription}"
}
}
}
@@ -608,24 +608,61 @@
}
},
"parameters": {
- "callback": {
+ "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": "JSONP",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"$.xgafv": {
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
"description": "V1 error format.",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
]
},
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
"alt": {
"description": "Data format for response.",
"default": "json",
@@ -643,9 +680,9 @@
"location": "query"
},
"key": {
- "location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"access_token": {
"location": "query",
@@ -653,121 +690,22 @@
"type": "string"
},
"quotaUser": {
- "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
}
},
"schemas": {
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "PullRequest": {
- "id": "PullRequest",
- "description": "Request for the `Pull` method.",
- "type": "object",
- "properties": {
- "returnImmediately": {
- "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.",
- "type": "boolean"
- },
- "maxMessages": {
- "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "ListSubscriptionsResponse": {
- "description": "Response for the `ListSubscriptions` method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
- "type": "string"
- },
- "subscriptions": {
- "description": "The subscriptions that match the request.",
- "type": "array",
- "items": {
- "$ref": "Subscription"
- }
- }
- },
- "id": "ListSubscriptionsResponse"
- },
- "PublishRequest": {
- "description": "Request for the Publish method.",
- "type": "object",
- "properties": {
- "messages": {
- "description": "The messages to publish.",
- "type": "array",
- "items": {
- "$ref": "PubsubMessage"
- }
- }
- },
- "id": "PublishRequest"
- },
"PublishResponse": {
"description": "Response for the `Publish` method.",
"type": "object",
"properties": {
"messageIds": {
+ "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.",
"type": "array",
"items": {
"type": "string"
- },
- "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."
+ }
}
},
"id": "PublishResponse"
@@ -776,14 +714,6 @@
"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."
- },
"ackDeadlineSeconds": {
"description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using pull.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.\n\nIf this parameter is 0, a default value of 10 seconds is used.",
"format": "int32",
@@ -792,6 +722,14 @@
"name": {
"description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.",
"type": "string"
+ },
+ "topic": {
+ "description": "The name of the topic from which this subscription is receiving messages.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.",
+ "type": "string"
+ },
+ "pushConfig": {
+ "$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."
}
},
"id": "Subscription"
@@ -815,9 +753,9 @@
"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"
+ "format": "byte",
+ "type": "string"
},
"version": {
"description": "Version of the `Policy`. The default version is 0.",
@@ -835,7 +773,6 @@
"id": "Policy"
},
"Topic": {
- "id": "Topic",
"description": "A topic resource.",
"type": "object",
"properties": {
@@ -843,7 +780,8 @@
"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.",
@@ -879,20 +817,31 @@
},
"id": "SetIamPolicyRequest"
},
+ "ModifyPushConfigRequest": {
+ "description": "Request for the ModifyPushConfig method.",
+ "type": "object",
+ "properties": {
+ "pushConfig": {
+ "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called.",
+ "$ref": "PushConfig"
+ }
+ },
+ "id": "ModifyPushConfigRequest"
+ },
"PubsubMessage": {
"description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.",
"type": "object",
"properties": {
"attributes": {
- "description": "Optional attributes for this message.",
- "type": "object",
"additionalProperties": {
"type": "string"
- }
+ },
+ "description": "Optional attributes for this message.",
+ "type": "object"
},
"messageId": {
- "type": "string",
- "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call."
+ "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.",
+ "type": "string"
},
"publishTime": {
"description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.",
@@ -907,17 +856,6 @@
},
"id": "PubsubMessage"
},
- "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"
- },
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
@@ -930,12 +868,32 @@
}
},
"role": {
- "type": "string",
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
}
},
"id": "Binding"
},
+ "AcknowledgeRequest": {
+ "description": "Request for the Acknowledge method.",
+ "type": "object",
+ "properties": {
+ "ackIds": {
+ "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "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"
+ },
"ListTopicsResponse": {
"description": "Response for the `ListTopics` method.",
"type": "object",
@@ -948,32 +906,12 @@
}
},
"nextPageToken": {
- "type": "string",
- "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`."
+ "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.",
+ "type": "string"
}
},
"id": "ListTopicsResponse"
},
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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": {
- "ackIds": {
- "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
"ListTopicSubscriptionsResponse": {
"description": "Response for the `ListTopicSubscriptions` method.",
"type": "object",
@@ -1010,13 +948,13 @@
"description": "A message and its corresponding acknowledgment ID.",
"type": "object",
"properties": {
+ "ackId": {
+ "description": "This ID can be used to acknowledge the received message.",
+ "type": "string"
+ },
"message": {
"$ref": "PubsubMessage",
"description": "The message."
- },
- "ackId": {
- "type": "string",
- "description": "This ID can be used to acknowledge the received message."
}
},
"id": "ReceivedMessage"
@@ -1030,14 +968,76 @@
"type": "string"
},
"attributes": {
- "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
- "type": "object",
"additionalProperties": {
"type": "string"
+ },
+ "description": "Endpoint configuration attributes.\n\nEvery endpoint has a set of API supported attributes that can be used to\ncontrol different aspects of the message delivery.\n\nThe currently supported attribute is `x-goog-version`, which you can\nuse to change the format of the push message. This attribute\nindicates the version of the data expected by the endpoint. This\ncontrols the shape of the envelope (i.e. its fields and metadata).\nThe endpoint version is based on the version of the Pub/Sub\nAPI.\n\nIf not present during the `CreateSubscription` call, it will default to\nthe version of the API used to make such call. If not present during a\n`ModifyPushConfig` call, its value will not be changed. `GetSubscription`\ncalls will always return a valid version, even if the subscription was\ncreated without this attribute.\n\nThe possible values for this attribute are:\n\n* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.\n* `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.",
+ "type": "object"
+ }
+ },
+ "id": "PushConfig"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
}
}
},
- "id": "PushConfig"
+ "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": {
+ "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PullRequest"
+ },
+ "ListSubscriptionsResponse": {
+ "description": "Response for the `ListSubscriptions` method.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.",
+ "type": "string"
+ },
+ "subscriptions": {
+ "description": "The subscriptions that match the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Subscription"
+ }
+ }
+ },
+ "id": "ListSubscriptionsResponse"
+ },
+ "PublishRequest": {
+ "description": "Request for the Publish method.",
+ "type": "object",
+ "properties": {
+ "messages": {
+ "description": "The messages to publish.",
+ "type": "array",
+ "items": {
+ "$ref": "PubsubMessage"
+ }
+ }
+ },
+ "id": "PublishRequest"
}
},
"icons": {
@@ -1051,11 +1051,11 @@
"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"
+ },
+ "https://www.googleapis.com/auth/pubsub": {
+ "description": "View and manage Pub/Sub topics and subscriptions"
}
}
}
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json
index d1f53a3..ed168d9 100644
--- a/runtimeconfig/v1/runtimeconfig-api.json
+++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,208 +1,13 @@
{
- "ownerName": "Google",
- "resources": {
- "operations": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$",
- "location": "path"
- }
- },
- "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": {
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "name": {
- "pattern": "^operations/.+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/operations/{operationsId}",
- "id": "runtimeconfig.operations.delete",
- "path": "v1/{+name}"
- },
- "list": {
- "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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
- "name": {
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string",
- "pattern": "^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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1/operations"
- }
- }
- }
- },
- "parameters": {
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "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": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1",
- "baseUrl": "https://runtimeconfig.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.\n",
- "servicePath": "",
- "basePath": "",
- "id": "runtimeconfig:v1",
- "revision": "20170224",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
+ "CancelOperationRequest": {
+ "properties": {},
+ "id": "CancelOperationRequest",
+ "description": "The request message for Operations.CancelOperation.",
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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",
@@ -249,13 +54,7 @@
"id": "ListOperationsResponse"
},
"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.",
@@ -279,26 +78,26 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
},
"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": {
- "properties": {},
- "id": "CancelOperationRequest",
- "description": "The request message for Operations.CancelOperation.",
- "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 RuntimeConfig",
@@ -318,5 +117,206 @@
"ownerDomain": "google.com",
"name": "runtimeconfig",
"batchPath": "batch",
- "title": "Google Cloud RuntimeConfig API"
+ "title": "Google Cloud RuntimeConfig API",
+ "ownerName": "Google",
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "path": "v1/{+name}:cancel",
+ "id": "runtimeconfig.operations.cancel",
+ "request": {
+ "$ref": "CancelOperationRequest"
+ },
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1/operations/{operationsId}:cancel"
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/operations/{operationsId}",
+ "id": "runtimeconfig.operations.delete",
+ "path": "v1/{+name}",
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string",
+ "pattern": "^operations$",
+ "location": "path"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "description": "The standard list filter.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/operations",
+ "id": "runtimeconfig.operations.list",
+ "path": "v1/{+name}",
+ "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`."
+ }
+ }
+ }
+ },
+ "parameters": {
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "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": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://runtimeconfig.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.\n",
+ "servicePath": "",
+ "basePath": "",
+ "id": "runtimeconfig:v1",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "revision": "20170224"
}
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json
index e37b6c3..65cc47f 100644
--- a/runtimeconfig/v1beta1/runtimeconfig-api.json
+++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,359 +1,13 @@
{
- "basePath": "",
- "revision": "20170224",
- "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
- "id": "runtimeconfig:v1beta1",
- "discoveryVersion": "v1",
- "version_module": "True",
- "schemas": {
- "TestIamPermissionsResponse": {
- "description": "Response message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse"
- },
- "ListVariablesResponse": {
- "id": "ListVariablesResponse",
- "description": "Response for the `ListVariables()` method.",
- "type": "object",
- "properties": {
- "variables": {
- "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
- "type": "array",
- "items": {
- "$ref": "Variable"
- }
- },
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- }
- }
- },
- "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": {
- "id": "WatchVariableRequest",
- "description": "Request for the `WatchVariable()` method.",
- "type": "object",
- "properties": {
- "newerThan": {
- "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "ListWaitersResponse": {
- "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- },
- "waiters": {
- "description": "Found waiters in the project.",
- "type": "array",
- "items": {
- "$ref": "Waiter"
- }
- }
- },
- "id": "ListWaitersResponse"
- },
- "Waiter": {
- "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
- "type": "object",
- "properties": {
- "error": {
- "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set.",
- "$ref": "Status"
- },
- "failure": {
- "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout.",
- "$ref": "EndCondition"
- },
- "success": {
- "$ref": "EndCondition",
- "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated."
- },
- "done": {
- "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
- "type": "boolean"
- },
- "createTime": {
- "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
- "format": "google-datetime",
- "type": "string"
- },
- "timeout": {
- "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
- "format": "google-duration",
- "type": "string"
- },
- "name": {
- "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
- "type": "string"
- }
- },
- "id": "Waiter"
- },
- "TestIamPermissionsRequest": {
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method.",
- "type": "object",
- "properties": {
- "permissions": {
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "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",
- "properties": {
- "value": {
- "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
- "format": "byte",
- "type": "string"
- },
- "updateTime": {
- "description": "[Output Only] The time of the last variable update.",
- "format": "google-datetime",
- "type": "string"
- },
- "state": {
- "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."
- ],
- "enum": [
- "VARIABLE_STATE_UNSPECIFIED",
- "UPDATED",
- "DELETED"
- ]
- },
- "name": {
- "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should follow RFC 1035 segment specification.\nThe length of a `[VARIABLE_NAME]` must be less than 256 bytes.\n\nOnce you create a variable, you cannot change the variable name.",
- "type": "string"
- },
- "text": {
- "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
- "type": "string"
- }
- }
- },
- "Policy": {
- "id": "Policy",
- "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
- "type": "object",
- "properties": {
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "version": {
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32",
- "type": "integer"
- },
- "bindings": {
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
- "type": "array",
- "items": {
- "$ref": "Binding"
- }
- }
- }
- },
- "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"
- }
- }
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "Status": {
- "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon 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"
- }
- }
- }
- }
- },
- "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* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Cardinality": {
- "id": "Cardinality",
- "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.",
- "type": "object",
- "properties": {
- "path": {
- "description": "The root of the variable subtree to monitor. For example, `/foo`.",
- "type": "string"
- },
- "number": {
- "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "ListConfigsResponse": {
- "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
- "type": "object",
- "properties": {
- "configs": {
- "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
- "type": "array",
- "items": {
- "$ref": "RuntimeConfig"
- }
- },
- "nextPageToken": {
- "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
- "type": "string"
- }
- },
- "id": "ListConfigsResponse"
- },
- "EndCondition": {
- "id": "EndCondition",
- "description": "The condition that a Waiter resource is waiting for.",
- "type": "object",
- "properties": {
- "cardinality": {
- "$ref": "Cardinality",
- "description": "The cardinality of the `EndCondition`."
- }
- }
- }
- },
- "protocol": "rest",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
"canonicalName": "Cloud RuntimeConfig",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/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"
}
}
}
@@ -369,189 +23,20 @@
"resources": {
"configs": {
"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 RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.delete",
- "description": "Deletes a RuntimeConfig resource."
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string"
- },
- "pageSize": {
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs",
- "id": "runtimeconfig.projects.configs.list",
- "path": "v1beta1/{+parent}/configs",
- "description": "Lists all the RuntimeConfig resources within project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListConfigsResponse"
- },
- "parameterOrder": [
- "parent"
- ]
- },
- "setIamPolicy": {
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
- "id": "runtimeconfig.projects.configs.setIamPolicy",
- "path": "v1beta1/{+resource}:setIamPolicy"
- },
- "create": {
- "id": "runtimeconfig.projects.configs.create",
- "path": "v1beta1/{+parent}/configs",
- "request": {
- "$ref": "RuntimeConfig"
- },
- "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameters": {
- "parent": {
- "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs"
- },
- "getIamPolicy": {
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- }
- },
- "get": {
- "description": "Gets information about a RuntimeConfig resource.",
- "response": {
- "$ref": "RuntimeConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.get"
- },
"update": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.update",
+ "request": {
+ "$ref": "RuntimeConfig"
+ },
+ "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.",
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "parameterOrder": [
+ "name"
],
+ "httpMethod": "PUT",
"parameters": {
"name": {
"description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
@@ -561,20 +46,11 @@
"location": "path"
}
},
- "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"
- },
- "httpMethod": "PUT",
- "parameterOrder": [
- "name"
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
],
- "response": {
- "$ref": "RuntimeConfig"
- }
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}"
},
"testIamPermissions": {
"path": "v1beta1/{+resource}:testIamPermissions",
@@ -604,212 +80,190 @@
}
},
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions"
+ },
+ "delete": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "path": "v1beta1/{+name}",
+ "id": "runtimeconfig.projects.configs.delete",
+ "description": "Deletes a RuntimeConfig resource."
+ },
+ "list": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "location": "query",
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "id": "runtimeconfig.projects.configs.list",
+ "path": "v1beta1/{+parent}/configs",
+ "description": "Lists all the RuntimeConfig resources within project."
+ },
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "requestId": {
+ "location": "query",
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs",
+ "id": "runtimeconfig.projects.configs.create",
+ "path": "v1beta1/{+parent}/configs",
+ "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.",
+ "request": {
+ "$ref": "RuntimeConfig"
+ }
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy",
+ "path": "v1beta1/{+resource}:setIamPolicy",
+ "id": "runtimeconfig.projects.configs.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
+ },
+ "getIamPolicy": {
+ "path": "v1beta1/{+resource}:getIamPolicy",
+ "id": "runtimeconfig.projects.configs.getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "RuntimeConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}",
+ "id": "runtimeconfig.projects.configs.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets information about a RuntimeConfig resource."
}
},
"resources": {
"variables": {
"methods": {
- "watch": {
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "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",
- "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."
- },
- "get": {
- "description": "Gets information about a single variable.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Variable"
- },
- "parameters": {
- "name": {
- "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
- "id": "runtimeconfig.projects.configs.variables.get",
- "path": "v1beta1/{+name}"
- },
- "update": {
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.update",
- "request": {
- "$ref": "Variable"
- },
- "description": "Updates an existing variable with a new value.",
- "response": {
- "$ref": "Variable"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "PUT",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path",
- "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}"
- },
- "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- },
- "permissions": {
- "repeated": true,
- "location": "query",
- "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": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions"
- },
- "delete": {
- "path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.variables.delete",
- "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "recursive": {
- "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
- "type": "boolean",
- "location": "query"
- },
- "name": {
- "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}"
- },
- "list": {
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
- ],
- "parameters": {
- "pageToken": {
- "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
- },
- "returnValues": {
- "location": "query",
- "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
- "type": "boolean"
- },
- "pageSize": {
- "location": "query",
- "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path",
- "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
- "required": true,
- "type": "string"
- },
- "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"
- }
- },
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "ListVariablesResponse"
- }
- },
"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"
- },
"response": {
"$ref": "Variable"
},
@@ -835,13 +289,216 @@
"type": "string"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables"
+ "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"
+ }
+ },
+ "watch": {
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "name": {
+ "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch",
+ "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."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Variable"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path",
+ "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "id": "runtimeconfig.projects.configs.variables.get",
+ "path": "v1beta1/{+name}",
+ "description": "Gets information about a single variable."
+ },
+ "update": {
+ "id": "runtimeconfig.projects.configs.variables.update",
+ "path": "v1beta1/{+name}",
+ "description": "Updates an existing variable with a new value.",
+ "request": {
+ "$ref": "Variable"
+ },
+ "httpMethod": "PUT",
+ "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 update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}"
+ },
+ "testIamPermissions": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "resource": {
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ },
+ "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": "string",
+ "repeated": true,
+ "location": "query"
+ }
+ },
+ "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."
+ },
+ "delete": {
+ "httpMethod": "DELETE",
+ "parameterOrder": [
+ "name"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "recursive": {
+ "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "name": {
+ "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}",
+ "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": {
+ "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListVariablesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
+ "type": "string",
+ "location": "query"
+ },
+ "returnValues": {
+ "location": "query",
+ "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.",
+ "type": "boolean"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables",
+ "id": "runtimeconfig.projects.configs.variables.list",
+ "path": "v1beta1/{+parent}/variables"
}
}
},
"operations": {
"methods": {
"testIamPermissions": {
+ "path": "v1beta1/{+resource}:testIamPermissions",
+ "id": "runtimeconfig.projects.configs.operations.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.",
"response": {
"$ref": "TestIamPermissionsResponse"
},
@@ -868,52 +525,45 @@
"type": "string"
}
},
- "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions",
- "path": "v1beta1/{+resource}:testIamPermissions",
- "id": "runtimeconfig.projects.configs.operations.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."
+ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions"
},
"get": {
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$",
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string"
- }
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "name"
+ ],
+ "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.",
+ "required": true,
+ "type": "string",
+ "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.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "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."
}
}
},
"waiters": {
"methods": {
"delete": {
- "parameterOrder": [
- "name"
- ],
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloudruntimeconfig"
+ "parameterOrder": [
+ "name"
],
"parameters": {
"name": {
@@ -924,19 +574,24 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudruntimeconfig"
+ ],
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
"path": "v1beta1/{+name}",
"id": "runtimeconfig.projects.configs.waiters.delete",
"description": "Deletes the waiter with the specified name."
},
"list": {
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
+ "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"
@@ -950,9 +605,9 @@
"type": "string"
},
"pageToken": {
+ "location": "query",
"description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageSize": {
"location": "query",
@@ -962,12 +617,10 @@
}
},
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
- "id": "runtimeconfig.projects.configs.waiters.list",
"path": "v1beta1/{+parent}/waiters",
- "description": "List waiters within the given configuration."
+ "id": "runtimeconfig.projects.configs.waiters.list"
},
"get": {
- "description": "Gets information about a single waiter.",
"response": {
"$ref": "Waiter"
},
@@ -990,7 +643,8 @@
],
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}",
"path": "v1beta1/{+name}",
- "id": "runtimeconfig.projects.configs.waiters.get"
+ "id": "runtimeconfig.projects.configs.waiters.get",
+ "description": "Gets information about a single waiter."
},
"create": {
"response": {
@@ -1000,40 +654,40 @@
"parent"
],
"httpMethod": "POST",
- "parameters": {
- "parent": {
- "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/configs/[^/]+$",
- "location": "path"
- },
- "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"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudruntimeconfig"
],
+ "parameters": {
+ "requestId": {
+ "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "parent": {
+ "pattern": "^projects/[^/]+/configs/[^/]+$",
+ "location": "path",
+ "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must by in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.",
+ "required": true,
+ "type": "string"
+ }
+ },
"flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters",
"path": "v1beta1/{+parent}/waiters",
"id": "runtimeconfig.projects.configs.waiters.create",
+ "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"
- },
- "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts."
+ }
},
"testIamPermissions": {
"httpMethod": "GET",
- "parameterOrder": [
- "resource"
- ],
"response": {
"$ref": "TestIamPermissionsResponse"
},
+ "parameterOrder": [
+ "resource"
+ ],
"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.",
@@ -1043,10 +697,10 @@
"location": "path"
},
"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": "string",
"repeated": true,
- "location": "query"
+ "location": "query",
+ "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": "string"
}
},
"scopes": [
@@ -1066,15 +720,51 @@
}
},
"parameters": {
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
+ "default": "true"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
"location": "query"
},
"uploadType": {
@@ -1082,14 +772,12 @@
"type": "string",
"location": "query"
},
- "fields": {
+ "callback": {
"location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
+ "description": "JSONP",
"type": "string"
},
"$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -1098,14 +786,13 @@
"enum": [
"1",
"2"
- ]
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -1117,45 +804,358 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
"location": "query"
}
},
"version": "v1beta1",
"baseUrl": "https://runtimeconfig.googleapis.com/",
"servicePath": "",
+ "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.\n",
"kind": "discovery#restDescription",
- "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.\n"
+ "basePath": "",
+ "id": "runtimeconfig:v1beta1",
+ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/",
+ "revision": "20170224",
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\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": {
+ "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* `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"
+ },
+ "Empty": {
+ "properties": {},
+ "id": "Empty",
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "type": "object"
+ },
+ "Cardinality": {
+ "properties": {
+ "path": {
+ "description": "The root of the variable subtree to monitor. For example, `/foo`.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Cardinality",
+ "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.",
+ "type": "object"
+ },
+ "ListConfigsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
+ "configs": {
+ "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
+ "type": "array",
+ "items": {
+ "$ref": "RuntimeConfig"
+ }
+ }
+ },
+ "id": "ListConfigsResponse",
+ "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.",
+ "type": "object"
+ },
+ "EndCondition": {
+ "description": "The condition that a Waiter resource is waiting for.",
+ "type": "object",
+ "properties": {
+ "cardinality": {
+ "$ref": "Cardinality",
+ "description": "The cardinality of the `EndCondition`."
+ }
+ },
+ "id": "EndCondition"
+ },
+ "TestIamPermissionsResponse": {
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse",
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object"
+ },
+ "ListVariablesResponse": {
+ "properties": {
+ "variables": {
+ "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.",
+ "type": "array",
+ "items": {
+ "$ref": "Variable"
+ }
+ },
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ }
+ },
+ "id": "ListVariablesResponse",
+ "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": {
+ "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.",
+ "format": "google-datetime",
+ "type": "string"
+ }
+ },
+ "id": "WatchVariableRequest",
+ "description": "Request for the `WatchVariable()` method.",
+ "type": "object"
+ },
+ "ListWaitersResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results",
+ "type": "string"
+ },
+ "waiters": {
+ "description": "Found waiters in the project.",
+ "type": "array",
+ "items": {
+ "$ref": "Waiter"
+ }
+ }
+ },
+ "id": "ListWaitersResponse",
+ "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.",
+ "type": "object"
+ },
+ "TestIamPermissionsRequest": {
+ "description": "Request message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsRequest"
+ },
+ "Waiter": {
+ "properties": {
+ "error": {
+ "$ref": "Status",
+ "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set."
+ },
+ "failure": {
+ "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout.",
+ "$ref": "EndCondition"
+ },
+ "success": {
+ "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.",
+ "$ref": "EndCondition"
+ },
+ "done": {
+ "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.",
+ "type": "boolean"
+ },
+ "createTime": {
+ "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "timeout": {
+ "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.",
+ "type": "string"
+ }
+ },
+ "id": "Waiter",
+ "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.",
+ "type": "object"
+ },
+ "Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
+ "properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
+ }
+ },
+ "id": "Policy"
+ },
+ "Variable": {
+ "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.",
+ "format": "byte",
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "[Output Only] The time of the last variable update.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "state": {
+ "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."
+ ]
+ },
+ "name": {
+ "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should follow RFC 1035 segment specification.\nThe length of a `[VARIABLE_NAME]` must be less than 256 bytes.\n\nOnce you create a variable, you cannot change the variable name.",
+ "type": "string"
+ },
+ "text": {
+ "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.",
+ "type": "string"
+ }
+ },
+ "id": "Variable"
+ },
+ "Operation": {
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "description": "The error result of the operation in case of failure or cancellation.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ }
+ },
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "policy": {
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.",
+ "$ref": "Policy"
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ }
+ },
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ },
+ "protocol": "rest"
}
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json
index f130ffe..b2b2378 100644
--- a/safebrowsing/v4/safebrowsing-api.json
+++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,804 +1,1040 @@
{
- "kind": "discovery#restDescription",
- "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/Yoew02BLq1-_QyzwsVjtSdddocY\"",
- "discoveryVersion": "v1",
- "id": "safebrowsing:v4",
- "name": "safebrowsing",
- "version": "v4",
- "revision": "20160520",
- "title": "Safe Browsing APIs",
- "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "documentationLink": "https://developers.google.com/safe-browsing/",
- "protocol": "rest",
- "baseUrl": "https://safebrowsing.googleapis.com/",
- "basePath": "",
- "rootUrl": "https://safebrowsing.googleapis.com/",
- "servicePath": "",
- "batchPath": "batch",
- "parameters": {
- "access_token": {
- "type": "string",
- "description": "OAuth access token.",
- "location": "query"
- },
- "alt": {
- "type": "string",
- "description": "Data format for response.",
- "default": "json",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- },
- "bearer_token": {
- "type": "string",
- "description": "OAuth bearer token.",
- "location": "query"
- },
- "callback": {
- "type": "string",
- "description": "JSONP",
- "location": "query"
- },
- "fields": {
- "type": "string",
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query"
- },
- "key": {
- "type": "string",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "location": "query"
- },
- "oauth_token": {
- "type": "string",
- "description": "OAuth 2.0 token for the current user.",
- "location": "query"
- },
- "pp": {
- "type": "boolean",
- "description": "Pretty-print response.",
- "default": "true",
- "location": "query"
- },
- "prettyPrint": {
- "type": "boolean",
- "description": "Returns response with indentations and line breaks.",
- "default": "true",
- "location": "query"
- },
- "quotaUser": {
- "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.",
- "location": "query"
- },
- "upload_protocol": {
- "type": "string",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query"
- },
- "$.xgafv": {
- "type": "string",
- "description": "V1 error format.",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- }
- },
- "schemas": {
- "FindThreatMatchesRequest": {
- "id": "FindThreatMatchesRequest",
- "type": "object",
- "description": "Request to check entries against lists.",
- "properties": {
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
+ "resources": {
+ "threatListUpdates": {
+ "methods": {
+ "fetch": {
+ "request": {
+ "$ref": "FetchThreatListUpdatesRequest"
+ },
+ "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v4/threatListUpdates:fetch",
+ "path": "v4/threatListUpdates:fetch",
+ "id": "safebrowsing.threatListUpdates.fetch"
+ }
+ }
},
- "threatInfo": {
- "$ref": "ThreatInfo",
- "description": "The lists and entries to be checked for matches."
- }
- }
- },
- "ClientInfo": {
- "id": "ClientInfo",
- "type": "object",
- "description": "The client metadata associated with Safe Browsing API requests.",
- "properties": {
- "clientId": {
- "type": "string",
- "description": "A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API."
+ "encodedFullHashes": {
+ "methods": {
+ "get": {
+ "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ "path": "v4/encodedFullHashes/{encodedRequest}",
+ "id": "safebrowsing.encodedFullHashes.get",
+ "description": "",
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "clientVersion": {
+ "location": "query",
+ "description": "The version of the client implementation.",
+ "type": "string"
+ },
+ "encodedRequest": {
+ "location": "path",
+ "description": "A serialized FindFullHashesRequest proto.",
+ "format": "byte",
+ "required": true,
+ "type": "string"
+ },
+ "clientId": {
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string",
+ "location": "query"
+ }
+ }
+ }
+ }
},
- "clientVersion": {
- "type": "string",
- "description": "The version of the client implementation."
- }
- }
- },
- "ThreatInfo": {
- "id": "ThreatInfo",
- "type": "object",
- "description": "The information regarding one or more threats that a client submits when checking for matches in threat lists.",
- "properties": {
- "threatTypes": {
- "type": "array",
- "description": "The threat types to be checked.",
- "enumDescriptions": [
- "Unknown.",
- "Malware threat type.",
- "Social engineering threat type.",
- "Unwanted software threat type.",
- "Potentially harmful application threat type."
- ],
- "items": {
- "type": "string",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ]
- }
- },
- "platformTypes": {
- "type": "array",
- "description": "The platform types to be checked.",
- "enumDescriptions": [
- "Unknown platform.",
- "Threat posed to Windows.",
- "Threat posed to Linux.",
- "Threat posed to Android.",
- "Threat posed to OS X.",
- "Threat posed to iOS.",
- "Threat posed to at least one of the defined platforms.",
- "Threat posed to all defined platforms.",
- "Threat posed to Chrome."
- ],
- "items": {
- "type": "string",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- }
- },
- "threatEntryTypes": {
- "type": "array",
- "description": "The entry types to be checked.",
- "enumDescriptions": [
- "Unspecified.",
- "A URL.",
- "An executable program.",
- "An IP range."
- ],
- "items": {
- "type": "string",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE"
- ]
- }
- },
- "threatEntries": {
- "type": "array",
- "description": "The threat entries to be checked.",
- "items": {
- "$ref": "ThreatEntry"
- }
- }
- }
- },
- "ThreatEntry": {
- "id": "ThreatEntry",
- "type": "object",
- "description": "An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.",
- "properties": {
- "hash": {
- "type": "string",
- "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.",
- "format": "byte"
- },
- "url": {
- "type": "string",
- "description": "A URL."
- },
- "digest": {
- "type": "string",
- "description": "The digest of an executable in SHA256 format. The API supports both binary and hex digests.",
- "format": "byte"
- }
- }
- },
- "FindThreatMatchesResponse": {
- "id": "FindThreatMatchesResponse",
- "type": "object",
- "properties": {
- "matches": {
- "type": "array",
- "description": "The threat list matches.",
- "items": {
- "$ref": "ThreatMatch"
- }
- }
- }
- },
- "ThreatMatch": {
- "id": "ThreatMatch",
- "type": "object",
- "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
- "properties": {
- "threatType": {
- "type": "string",
- "description": "The threat type matching this threat.",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ]
- },
- "platformType": {
- "type": "string",
- "description": "The platform type matching this threat.",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- },
- "threatEntryType": {
- "type": "string",
- "description": "The threat entry type matching this threat.",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE"
- ]
- },
- "threat": {
- "$ref": "ThreatEntry",
- "description": "The threat matching this threat."
- },
- "threatEntryMetadata": {
- "$ref": "ThreatEntryMetadata",
- "description": "Optional metadata associated with this threat."
- },
- "cacheDuration": {
- "type": "string",
- "description": "The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives."
- }
- }
- },
- "ThreatEntryMetadata": {
- "id": "ThreatEntryMetadata",
- "type": "object",
- "description": "The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.",
- "properties": {
- "entries": {
- "type": "array",
- "description": "The metadata entries.",
- "items": {
- "$ref": "MetadataEntry"
- }
- }
- }
- },
- "MetadataEntry": {
- "id": "MetadataEntry",
- "type": "object",
- "description": "A single metadata entry.",
- "properties": {
- "key": {
- "type": "string",
- "description": "The metadata entry key.",
- "format": "byte"
- },
- "value": {
- "type": "string",
- "description": "The metadata entry value.",
- "format": "byte"
- }
- }
- },
- "FetchThreatListUpdatesRequest": {
- "id": "FetchThreatListUpdatesRequest",
- "type": "object",
- "description": "Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. NOTE: Field index 2 is unused. NEXT: 4",
- "properties": {
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
- },
- "listUpdateRequests": {
- "type": "array",
- "description": "The requested threat list updates.",
- "items": {
- "$ref": "ListUpdateRequest"
- }
- }
- }
- },
- "ListUpdateRequest": {
- "id": "ListUpdateRequest",
- "type": "object",
- "description": "A single list update request.",
- "properties": {
- "threatType": {
- "type": "string",
- "description": "The type of threat posed by entries present in the list.",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ]
- },
- "platformType": {
- "type": "string",
- "description": "The type of platform at risk by entries present in the list.",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- },
- "threatEntryType": {
- "type": "string",
- "description": "The types of entries present in the list.",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE"
- ]
- },
- "state": {
- "type": "string",
- "description": "The current state of the client for the requested list (the encrypted client state that was received from the last successful list update).",
- "format": "byte"
- },
- "constraints": {
- "$ref": "Constraints",
- "description": "The constraints associated with this request."
- }
- }
- },
- "Constraints": {
- "id": "Constraints",
- "type": "object",
- "description": "The constraints for this update.",
- "properties": {
- "maxUpdateEntries": {
- "type": "integer",
- "description": "The maximum size in number of entries. The update will not contain more entries than this value. This should be a power of 2 between 2**10 and 2**20. If zero, no update size limit is set.",
- "format": "int32"
- },
- "maxDatabaseEntries": {
- "type": "integer",
- "description": "Sets the maximum number of entries that the client is willing to have in the local database. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set.",
- "format": "int32"
- },
- "region": {
- "type": "string",
- "description": "Requests the list for a specific geographic location. If not set the server may pick that value based on the user's IP address. Expects ISO 3166-1 alpha-2 format."
- },
- "supportedCompressions": {
- "type": "array",
- "description": "The compression types supported by the client.",
- "enumDescriptions": [
- "Unknown.",
- "Raw, uncompressed data.",
- "Rice-Golomb encoded data."
- ],
- "items": {
- "type": "string",
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- }
- }
- }
- },
- "FetchThreatListUpdatesResponse": {
- "id": "FetchThreatListUpdatesResponse",
- "type": "object",
- "properties": {
- "listUpdateResponses": {
- "type": "array",
- "description": "The list updates requested by the clients.",
- "items": {
- "$ref": "ListUpdateResponse"
- }
- },
- "minimumWaitDuration": {
- "type": "string",
- "description": "The minimum duration the client must wait before issuing any update request. If this field is not set clients may update as soon as they want."
- }
- }
- },
- "ListUpdateResponse": {
- "id": "ListUpdateResponse",
- "type": "object",
- "description": "An update to an individual list.",
- "properties": {
- "threatType": {
- "type": "string",
- "description": "The threat type for which data is returned.",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ]
- },
- "threatEntryType": {
- "type": "string",
- "description": "The format of the threats.",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE"
- ]
- },
- "platformType": {
- "type": "string",
- "description": "The platform type for which data is returned.",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
- },
- "responseType": {
- "type": "string",
- "description": "The type of response. This may indicate that an action is required by the client when the response is received.",
- "enum": [
- "RESPONSE_TYPE_UNSPECIFIED",
- "PARTIAL_UPDATE",
- "FULL_UPDATE"
- ]
- },
- "additions": {
- "type": "array",
- "description": "A set of entries to add to a local threat type's list. Repeated to allow for a combination of compressed and raw data to be sent in a single response.",
- "items": {
- "$ref": "ThreatEntrySet"
- }
- },
- "removals": {
- "type": "array",
- "description": "A set of entries to remove from a local threat type's list. Repeated for the same reason as above.",
- "items": {
- "$ref": "ThreatEntrySet"
- }
- },
- "newClientState": {
- "type": "string",
- "description": "The new client state, in encrypted format. Opaque to clients.",
- "format": "byte"
- },
- "checksum": {
- "$ref": "Checksum",
- "description": "The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided update. If the client state doesn't match the expected state, the client must disregard this update and retry later."
- }
- }
- },
- "ThreatEntrySet": {
- "id": "ThreatEntrySet",
- "type": "object",
- "description": "A set of threats that should be added or removed from a client's local database.",
- "properties": {
- "compressionType": {
- "type": "string",
- "description": "The compression type for the entries in this set.",
- "enum": [
- "COMPRESSION_TYPE_UNSPECIFIED",
- "RAW",
- "RICE"
- ]
- },
- "rawHashes": {
- "$ref": "RawHashes",
- "description": "The raw SHA256-formatted entries."
- },
- "rawIndices": {
- "$ref": "RawIndices",
- "description": "The raw removal indices for a local list."
- },
- "riceHashes": {
- "$ref": "RiceDeltaEncoding",
- "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a Golomb-Rice encoding."
- },
- "riceIndices": {
- "$ref": "RiceDeltaEncoding",
- "description": "The encoded local, lexicographically-sorted list indices, using a Golomb-Rice encoding. Used for sending compressed removal indices."
- }
- }
- },
- "RawHashes": {
- "id": "RawHashes",
- "type": "object",
- "description": "The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.",
- "properties": {
- "prefixSize": {
- "type": "integer",
- "description": "The number of bytes for each prefix encoded below. This field can be anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
- "format": "int32"
- },
- "rawHashes": {
- "type": "string",
- "description": "The hashes, all concatenated into one long string. Each hash has a prefix size of |prefix_size| above. Hashes are sorted in lexicographic order.",
- "format": "byte"
- }
- }
- },
- "RawIndices": {
- "id": "RawIndices",
- "type": "object",
- "description": "A set of raw indices to remove from a local list.",
- "properties": {
- "indices": {
- "type": "array",
- "description": "The indices to remove from a lexicographically-sorted local list.",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- }
- }
- },
- "RiceDeltaEncoding": {
- "id": "RiceDeltaEncoding",
- "type": "object",
- "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.",
- "properties": {
- "firstValue": {
- "type": "string",
- "description": "The offset of the first entry in the encoded data, or, if only a single integer was encoded, that single integer's value.",
- "format": "int64"
- },
- "riceParameter": {
- "type": "integer",
- "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field is missing (that is, zero) if `num_entries` is zero.",
- "format": "int32"
- },
- "numEntries": {
- "type": "integer",
- "description": "The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.",
- "format": "int32"
- },
- "encodedData": {
- "type": "string",
- "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
- "format": "byte"
- }
- }
- },
- "Checksum": {
- "id": "Checksum",
- "type": "object",
- "description": "The expected state of a client's local database.",
- "properties": {
- "sha256": {
- "type": "string",
- "description": "The SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database.",
- "format": "byte"
- }
- }
- },
- "FindFullHashesRequest": {
- "id": "FindFullHashesRequest",
- "type": "object",
- "description": "Request to return full hashes matched by the provided hash prefixes.",
- "properties": {
- "client": {
- "$ref": "ClientInfo",
- "description": "The client metadata."
- },
- "clientStates": {
- "type": "array",
- "description": "The current client states for each of the client's local threat lists.",
- "items": {
- "type": "string",
- "format": "byte"
- }
- },
- "threatInfo": {
- "$ref": "ThreatInfo",
- "description": "The lists and hashes to be checked."
- }
- }
- },
- "FindFullHashesResponse": {
- "id": "FindFullHashesResponse",
- "type": "object",
- "properties": {
- "matches": {
- "type": "array",
- "description": "The full hashes that matched the requested prefixes.",
- "items": {
- "$ref": "ThreatMatch"
- }
- },
- "minimumWaitDuration": {
- "type": "string",
- "description": "The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want."
- },
- "negativeCacheDuration": {
- "type": "string",
- "description": "For requested entities that did not match the threat list, how long to cache the response."
- }
- }
- },
- "ListThreatListsResponse": {
- "id": "ListThreatListsResponse",
- "type": "object",
- "properties": {
"threatLists": {
- "type": "array",
- "description": "The lists available for download by the client.",
- "items": {
- "$ref": "ThreatListDescriptor"
- }
- }
- }
- },
- "ThreatListDescriptor": {
- "id": "ThreatListDescriptor",
- "type": "object",
- "description": "Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.",
- "properties": {
- "threatType": {
- "type": "string",
- "description": "The threat type posed by the list's entries.",
- "enum": [
- "THREAT_TYPE_UNSPECIFIED",
- "MALWARE",
- "SOCIAL_ENGINEERING",
- "UNWANTED_SOFTWARE",
- "POTENTIALLY_HARMFUL_APPLICATION"
- ]
+ "methods": {
+ "list": {
+ "description": "Lists the Safe Browsing threat lists available for download.",
+ "response": {
+ "$ref": "ListThreatListsResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "GET",
+ "parameters": {},
+ "flatPath": "v4/threatLists",
+ "path": "v4/threatLists",
+ "id": "safebrowsing.threatLists.list"
+ }
+ }
},
- "platformType": {
- "type": "string",
- "description": "The platform type targeted by the list's entries.",
- "enum": [
- "PLATFORM_TYPE_UNSPECIFIED",
- "WINDOWS",
- "LINUX",
- "ANDROID",
- "OSX",
- "IOS",
- "ANY_PLATFORM",
- "ALL_PLATFORMS",
- "CHROME"
- ]
+ "threatMatches": {
+ "methods": {
+ "find": {
+ "request": {
+ "$ref": "FindThreatMatchesRequest"
+ },
+ "description": "Finds the threat entries that match the Safe Browsing lists.",
+ "response": {
+ "$ref": "FindThreatMatchesResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v4/threatMatches:find",
+ "path": "v4/threatMatches:find",
+ "id": "safebrowsing.threatMatches.find"
+ }
+ }
},
- "threatEntryType": {
- "type": "string",
- "description": "The entry types contained in the list.",
- "enum": [
- "THREAT_ENTRY_TYPE_UNSPECIFIED",
- "URL",
- "EXECUTABLE",
- "IP_RANGE"
- ]
+ "fullHashes": {
+ "methods": {
+ "find": {
+ "request": {
+ "$ref": "FindFullHashesRequest"
+ },
+ "description": "Finds the full hashes that match the requested hash prefixes.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "FindFullHashesResponse"
+ },
+ "parameters": {},
+ "flatPath": "v4/fullHashes:find",
+ "id": "safebrowsing.fullHashes.find",
+ "path": "v4/fullHashes:find"
+ }
+ }
+ },
+ "encodedUpdates": {
+ "methods": {
+ "get": {
+ "response": {
+ "$ref": "FetchThreatListUpdatesResponse"
+ },
+ "parameterOrder": [
+ "encodedRequest"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "clientVersion": {
+ "location": "query",
+ "description": "The version of the client implementation.",
+ "type": "string"
+ },
+ "encodedRequest": {
+ "location": "path",
+ "description": "A serialized FetchThreatListUpdatesRequest proto.",
+ "format": "byte",
+ "required": true,
+ "type": "string"
+ },
+ "clientId": {
+ "location": "query",
+ "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
+ "type": "string"
+ }
+ },
+ "flatPath": "v4/encodedUpdates/{encodedRequest}",
+ "path": "v4/encodedUpdates/{encodedRequest}",
+ "id": "safebrowsing.encodedUpdates.get",
+ "description": ""
+ }
+ }
}
- }
- }
- },
- "resources": {
- "threatMatches": {
- "methods": {
- "find": {
- "id": "safebrowsing.threatMatches.find",
- "path": "v4/threatMatches:find",
- "httpMethod": "POST",
- "description": "Finds the threat entries that match the Safe Browsing lists.",
- "request": {
- "$ref": "FindThreatMatchesRequest"
- },
- "response": {
- "$ref": "FindThreatMatchesResponse"
- }
- }
- }
},
- "threatListUpdates": {
- "methods": {
- "fetch": {
- "id": "safebrowsing.threatListUpdates.fetch",
- "path": "v4/threatListUpdates:fetch",
- "httpMethod": "POST",
- "description": "Fetches the most recent threat list updates. A client can request updates for multiple lists at once.",
- "request": {
- "$ref": "FetchThreatListUpdatesRequest"
- },
- "response": {
- "$ref": "FetchThreatListUpdatesResponse"
- }
+ "parameters": {
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "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"
}
- }
},
- "fullHashes": {
- "methods": {
- "find": {
- "id": "safebrowsing.fullHashes.find",
- "path": "v4/fullHashes:find",
- "httpMethod": "POST",
- "description": "Finds the full hashes that match the requested hash prefixes.",
- "request": {
- "$ref": "FindFullHashesRequest"
- },
- "response": {
- "$ref": "FindFullHashesResponse"
- }
+ "schemas": {
+ "MetadataEntry": {
+ "description": "A single metadata entry.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The metadata entry value. For JSON requests, the value is base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "key": {
+ "description": "The metadata entry key. For JSON requests, the key is base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "MetadataEntry"
+ },
+ "ClientInfo": {
+ "description": "The client metadata associated with Safe Browsing API requests.",
+ "type": "object",
+ "properties": {
+ "clientId": {
+ "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ "type": "string"
+ },
+ "clientVersion": {
+ "description": "The version of the client implementation.",
+ "type": "string"
+ }
+ },
+ "id": "ClientInfo"
+ },
+ "FindThreatMatchesRequest": {
+ "description": "Request to check entries against lists.",
+ "type": "object",
+ "properties": {
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ },
+ "threatInfo": {
+ "$ref": "ThreatInfo",
+ "description": "The lists and entries to be checked for matches."
+ }
+ },
+ "id": "FindThreatMatchesRequest"
+ },
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ]
+ }
+ },
+ "threatTypes": {
+ "description": "The threat types to be checked.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ]
+ },
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type."
+ ]
+ },
+ "platformTypes": {
+ "description": "The platform types to be checked.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "type": "string"
+ },
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ]
+ },
+ "threatEntries": {
+ "description": "The threat entries to be checked.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntry"
+ }
+ }
+ },
+ "id": "ThreatInfo"
+ },
+ "ThreatEntryMetadata": {
+ "description": "The metadata associated with a specific threat entry. The client is expected\nto know the metadata key/value pairs associated with each threat type.",
+ "type": "object",
+ "properties": {
+ "entries": {
+ "description": "The metadata entries.",
+ "type": "array",
+ "items": {
+ "$ref": "MetadataEntry"
+ }
+ }
+ },
+ "id": "ThreatEntryMetadata"
+ },
+ "RawIndices": {
+ "description": "A set of raw indices to remove from a local list.",
+ "type": "object",
+ "properties": {
+ "indices": {
+ "description": "The indices to remove from a lexicographically-sorted local list.",
+ "type": "array",
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "id": "RawIndices"
+ },
+ "RawHashes": {
+ "description": "The uncompressed threat entries in hash format of a particular prefix length.\nHashes can be anywhere from 4 to 32 bytes in size. A large majority are 4\nbytes, but some hashes are lengthened if they collide with the hash of a\npopular URL.\n\nUsed for sending ThreatEntrySet to clients that do not support compression,\nor when sending non-4-byte hashes to clients that do support compression.",
+ "type": "object",
+ "properties": {
+ "rawHashes": {
+ "description": "The hashes, in binary format, concatenated into one long string. Hashes are\nsorted in lexicographic order. For JSON API users, hashes are\nbase64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "prefixSize": {
+ "description": "The number of bytes for each prefix encoded below. This field can be\nanywhere from 4 (shortest prefix) to 32 (full SHA256 hash).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RawHashes"
+ },
+ "FetchThreatListUpdatesResponse": {
+ "type": "object",
+ "properties": {
+ "listUpdateResponses": {
+ "description": "The list updates requested by the clients.",
+ "type": "array",
+ "items": {
+ "$ref": "ListUpdateResponse"
+ }
+ },
+ "minimumWaitDuration": {
+ "description": "The minimum duration the client must wait before issuing any update\nrequest. If this field is not set clients may update as soon as they want.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "FetchThreatListUpdatesResponse"
+ },
+ "FindFullHashesResponse": {
+ "type": "object",
+ "properties": {
+ "matches": {
+ "description": "The full hashes that matched the requested prefixes.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ },
+ "negativeCacheDuration": {
+ "description": "For requested entities that did not match the threat list, how long to\ncache the response.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "minimumWaitDuration": {
+ "description": "The minimum duration the client must wait before issuing any find hashes\nrequest. If this field is not set, clients can issue a request as soon as\nthey want.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "id": "FindFullHashesResponse"
+ },
+ "Checksum": {
+ "description": "The expected state of a client's local database.",
+ "type": "object",
+ "properties": {
+ "sha256": {
+ "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "Checksum"
+ },
+ "ThreatEntrySet": {
+ "description": "A set of threats that should be added or removed from a client's local\ndatabase.",
+ "type": "object",
+ "properties": {
+ "compressionType": {
+ "description": "The compression type for the entries in this set.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ],
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ]
+ },
+ "riceIndices": {
+ "description": "The encoded local, lexicographically-sorted list indices, using a\nGolomb-Rice encoding. Used for sending compressed removal indices. The\nremoval indices (uint32) are sorted in ascending order, then delta encoded\nand stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
+ },
+ "rawIndices": {
+ "description": "The raw removal indices for a local list.",
+ "$ref": "RawIndices"
+ },
+ "rawHashes": {
+ "description": "The raw SHA256-formatted entries.",
+ "$ref": "RawHashes"
+ },
+ "riceHashes": {
+ "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data.",
+ "$ref": "RiceDeltaEncoding"
+ }
+ },
+ "id": "ThreatEntrySet"
+ },
+ "FindFullHashesRequest": {
+ "description": "Request to return full hashes matched by the provided hash prefixes.",
+ "type": "object",
+ "properties": {
+ "client": {
+ "description": "The client metadata.",
+ "$ref": "ClientInfo"
+ },
+ "threatInfo": {
+ "$ref": "ThreatInfo",
+ "description": "The lists and hashes to be checked."
+ },
+ "apiClient": {
+ "$ref": "ClientInfo",
+ "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation."
+ },
+ "clientStates": {
+ "description": "The current client states for each of the client's local threat lists.",
+ "type": "array",
+ "items": {
+ "format": "byte",
+ "type": "string"
+ }
+ }
+ },
+ "id": "FindFullHashesRequest"
+ },
+ "ListUpdateRequest": {
+ "description": "A single list update request.",
+ "type": "object",
+ "properties": {
+ "platformType": {
+ "description": "The type of platform at risk by entries present in the list.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ]
+ },
+ "threatType": {
+ "description": "The type of threat posed by entries present in the list.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown.",
+ "Malware threat type.",
+ "Social engineering threat type.",
+ "Unwanted software threat type.",
+ "Potentially harmful application threat type."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ]
+ },
+ "constraints": {
+ "$ref": "Constraints",
+ "description": "The constraints associated with this request."
+ },
+ "threatEntryType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The types of entries present in the list.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ListUpdateRequest"
+ },
+ "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": {
+ "client": {
+ "$ref": "ClientInfo",
+ "description": "The client metadata."
+ },
+ "listUpdateRequests": {
+ "description": "The requested threat list updates.",
+ "type": "array",
+ "items": {
+ "$ref": "ListUpdateRequest"
+ }
+ }
+ },
+ "id": "FetchThreatListUpdatesRequest"
+ },
+ "ListUpdateResponse": {
+ "description": "An update to an individual list.",
+ "type": "object",
+ "properties": {
+ "platformType": {
+ "description": "The platform type for which data is returned.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ]
+ },
+ "threatEntryType": {
+ "description": "The format of the threats.",
+ "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"
+ ]
+ },
+ "additions": {
+ "description": "A set of entries to add to a local threat type's list. Repeated to allow\nfor a combination of compressed and raw data to be sent in a single\nresponse.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ }
+ },
+ "checksum": {
+ "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later.",
+ "$ref": "Checksum"
+ },
+ "responseType": {
+ "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."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ],
+ "description": "The threat type for which data is returned.",
+ "type": "string"
+ },
+ "removals": {
+ "description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatEntrySet"
+ }
+ },
+ "newClientState": {
+ "description": "The new client state, in encrypted format. Opaque to clients.",
+ "format": "byte",
+ "type": "string"
+ }
+ },
+ "id": "ListUpdateResponse"
+ },
+ "Constraints": {
+ "description": "The constraints for this update.",
+ "type": "object",
+ "properties": {
+ "maxDatabaseEntries": {
+ "description": "Sets the maximum number of entries that the client is willing to have\nin the local database. This should be a power of 2 between 2**10 and\n2**20. If zero, no database size limit is set.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "region": {
+ "description": "Requests the list for a specific geographic location. If not set the\nserver may pick that value based on the user's IP address. Expects ISO\n3166-1 alpha-2 format.",
+ "type": "string"
+ },
+ "supportedCompressions": {
+ "enumDescriptions": [
+ "Unknown.",
+ "Raw, uncompressed data.",
+ "Rice-Golomb encoded data."
+ ],
+ "description": "The compression types supported by the client.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "COMPRESSION_TYPE_UNSPECIFIED",
+ "RAW",
+ "RICE"
+ ]
+ }
+ },
+ "maxUpdateEntries": {
+ "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Constraints"
+ },
+ "ThreatMatch": {
+ "description": "A match when checking a threat entry in the Safe Browsing threat lists.",
+ "type": "object",
+ "properties": {
+ "threat": {
+ "description": "The threat matching this threat.",
+ "$ref": "ThreatEntry"
+ },
+ "platformType": {
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ],
+ "description": "The platform type matching this threat.",
+ "type": "string"
+ },
+ "threatEntryType": {
+ "enumDescriptions": [
+ "Unspecified.",
+ "A URL.",
+ "An executable program.",
+ "An IP range.",
+ "Chrome extension.",
+ "Filename.",
+ "CERT"
+ ],
+ "enum": [
+ "THREAT_ENTRY_TYPE_UNSPECIFIED",
+ "URL",
+ "EXECUTABLE",
+ "IP_RANGE",
+ "CHROME_EXTENSION",
+ "FILENAME",
+ "CERT"
+ ],
+ "description": "The threat entry type matching this threat.",
+ "type": "string"
+ },
+ "cacheDuration": {
+ "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.",
+ "format": "google-duration",
+ "type": "string"
+ },
+ "threatType": {
+ "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."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ]
+ },
+ "threatEntryMetadata": {
+ "description": "Optional metadata associated with this threat.",
+ "$ref": "ThreatEntryMetadata"
+ }
+ },
+ "id": "ThreatMatch"
+ },
+ "RiceDeltaEncoding": {
+ "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.",
+ "type": "object",
+ "properties": {
+ "firstValue": {
+ "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "encodedData": {
+ "description": "The encoded deltas that are encoded using the Golomb-Rice coder.",
+ "format": "byte",
+ "type": "string"
+ },
+ "numEntries": {
+ "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "riceParameter": {
+ "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "RiceDeltaEncoding"
+ },
+ "ListThreatListsResponse": {
+ "type": "object",
+ "properties": {
+ "threatLists": {
+ "description": "The lists available for download by the client.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatListDescriptor"
+ }
+ }
+ },
+ "id": "ListThreatListsResponse"
+ },
+ "FindThreatMatchesResponse": {
+ "type": "object",
+ "properties": {
+ "matches": {
+ "description": "The threat list matches.",
+ "type": "array",
+ "items": {
+ "$ref": "ThreatMatch"
+ }
+ }
+ },
+ "id": "FindThreatMatchesResponse"
+ },
+ "ThreatEntry": {
+ "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.",
+ "type": "object",
+ "properties": {
+ "digest": {
+ "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "hash": {
+ "description": "A hash prefix, consisting of the most significant 4-32 bytes of a SHA256\nhash. This field is in binary format. For JSON requests, hashes are\nbase64-encoded.",
+ "format": "byte",
+ "type": "string"
+ },
+ "url": {
+ "description": "A URL.",
+ "type": "string"
+ }
+ },
+ "id": "ThreatEntry"
+ },
+ "ThreatListDescriptor": {
+ "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.",
+ "type": "object",
+ "properties": {
+ "platformType": {
+ "description": "The platform type targeted by the list's entries.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown platform.",
+ "Threat posed to Windows.",
+ "Threat posed to Linux.",
+ "Threat posed to Android.",
+ "Threat posed to OS X.",
+ "Threat posed to iOS.",
+ "Threat posed to at least one of the defined platforms.",
+ "Threat posed to all defined platforms.",
+ "Threat posed to Chrome."
+ ],
+ "enum": [
+ "PLATFORM_TYPE_UNSPECIFIED",
+ "WINDOWS",
+ "LINUX",
+ "ANDROID",
+ "OSX",
+ "IOS",
+ "ANY_PLATFORM",
+ "ALL_PLATFORMS",
+ "CHROME"
+ ]
+ },
+ "threatType": {
+ "description": "The 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."
+ ],
+ "enum": [
+ "THREAT_TYPE_UNSPECIFIED",
+ "MALWARE",
+ "SOCIAL_ENGINEERING",
+ "UNWANTED_SOFTWARE",
+ "POTENTIALLY_HARMFUL_APPLICATION"
+ ]
+ },
+ "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"
+ ]
+ }
+ },
+ "id": "ThreatListDescriptor"
}
- }
},
- "threatLists": {
- "methods": {
- "list": {
- "id": "safebrowsing.threatLists.list",
- "path": "v4/threatLists",
- "httpMethod": "GET",
- "description": "Lists the Safe Browsing threat lists available for download.",
- "response": {
- "$ref": "ListThreatListsResponse"
- }
- }
- }
- }
- }
+ "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": "v4",
+ "baseUrl": "https://safebrowsing.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "servicePath": "",
+ "description": "The Safe Browsing API is an experimental API that allows client applications to check URLs against Google's constantly-updated blacklists of suspected phishing and malware pages. Your client application can use the API to download an encrypted table for local, client-side lookups of URLs.",
+ "rootUrl": "https://safebrowsing.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "safebrowsing",
+ "batchPath": "batch",
+ "id": "safebrowsing:v4",
+ "documentationLink": "https://developers.google.com/safe-browsing/",
+ "revision": "20170306",
+ "title": "Google Safe Browsing API",
+ "ownerName": "Google",
+ "discoveryVersion": "v1"
}
diff --git a/safebrowsing/v4/safebrowsing-gen.go b/safebrowsing/v4/safebrowsing-gen.go
index 1ce67a2..39b6128 100644
--- a/safebrowsing/v4/safebrowsing-gen.go
+++ b/safebrowsing/v4/safebrowsing-gen.go
@@ -1,4 +1,4 @@
-// Package safebrowsing provides access to the Safe Browsing APIs.
+// Package safebrowsing provides access to the Google Safe Browsing API.
//
// See https://developers.google.com/safe-browsing/
//
@@ -50,6 +50,8 @@
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
+ s.EncodedFullHashes = NewEncodedFullHashesService(s)
+ s.EncodedUpdates = NewEncodedUpdatesService(s)
s.FullHashes = NewFullHashesService(s)
s.ThreatListUpdates = NewThreatListUpdatesService(s)
s.ThreatLists = NewThreatListsService(s)
@@ -63,6 +65,10 @@
UserAgent string // optional additional User-Agent fragment
GoogleClientHeaderElement string // client header fragment, for Google use only
+ EncodedFullHashes *EncodedFullHashesService
+
+ EncodedUpdates *EncodedUpdatesService
+
FullHashes *FullHashesService
ThreatListUpdates *ThreatListUpdatesService
@@ -83,6 +89,24 @@
return gensupport.GoogleClientHeader("20170210", s.GoogleClientHeaderElement)
}
+func NewEncodedFullHashesService(s *Service) *EncodedFullHashesService {
+ rs := &EncodedFullHashesService{s: s}
+ return rs
+}
+
+type EncodedFullHashesService struct {
+ s *Service
+}
+
+func NewEncodedUpdatesService(s *Service) *EncodedUpdatesService {
+ rs := &EncodedUpdatesService{s: s}
+ return rs
+}
+
+type EncodedUpdatesService struct {
+ s *Service
+}
+
func NewFullHashesService(s *Service) *FullHashesService {
rs := &FullHashesService{s: s}
return rs
@@ -122,7 +146,8 @@
// Checksum: The expected state of a client's local database.
type Checksum struct {
// Sha256: The SHA256 hash of the client state; that is, of the sorted
- // list of all hashes present in the database.
+ // list of all
+ // hashes present in the database.
Sha256 string `json:"sha256,omitempty"`
// ForceSendFields is a list of field names (e.g. "Sha256") to
@@ -152,7 +177,8 @@
// requests.
type ClientInfo struct {
// ClientId: A client ID that (hopefully) uniquely identifies the client
- // implementation of the Safe Browsing API.
+ // implementation
+ // of the Safe Browsing API.
ClientId string `json:"clientId,omitempty"`
// ClientVersion: The version of the client implementation.
@@ -184,19 +210,24 @@
// Constraints: The constraints for this update.
type Constraints struct {
// MaxDatabaseEntries: Sets the maximum number of entries that the
- // client is willing to have in the local database. This should be a
- // power of 2 between 2**10 and 2**20. If zero, no database size limit
- // is set.
+ // client is willing to have
+ // in the local database. This should be a power of 2 between 2**10
+ // and
+ // 2**20. If zero, no database size limit is set.
MaxDatabaseEntries int64 `json:"maxDatabaseEntries,omitempty"`
// MaxUpdateEntries: The maximum size in number of entries. The update
- // will not contain more entries than this value. This should be a power
- // of 2 between 2**10 and 2**20. If zero, no update size limit is set.
+ // will not contain more
+ // entries than this value. This should be a power of 2 between 2**10
+ // and
+ // 2**20. If zero, no update size limit is set.
MaxUpdateEntries int64 `json:"maxUpdateEntries,omitempty"`
// Region: Requests the list for a specific geographic location. If not
- // set the server may pick that value based on the user's IP address.
- // Expects ISO 3166-1 alpha-2 format.
+ // set the
+ // server may pick that value based on the user's IP address. Expects
+ // ISO
+ // 3166-1 alpha-2 format.
Region string `json:"region,omitempty"`
// SupportedCompressions: The compression types supported by the client.
@@ -232,8 +263,10 @@
}
// FetchThreatListUpdatesRequest: Describes a Safe Browsing API update
-// request. Clients can request updates for multiple lists in a single
-// request. NOTE: Field index 2 is unused. NEXT: 4
+// request. Clients can request updates for
+// multiple lists in a single request.
+// NOTE: Field index 2 is unused.
+// NEXT: 5
type FetchThreatListUpdatesRequest struct {
// Client: The client metadata.
Client *ClientInfo `json:"client,omitempty"`
@@ -269,8 +302,9 @@
ListUpdateResponses []*ListUpdateResponse `json:"listUpdateResponses,omitempty"`
// MinimumWaitDuration: The minimum duration the client must wait before
- // issuing any update request. If this field is not set clients may
- // update as soon as they want.
+ // issuing any update
+ // request. If this field is not set clients may update as soon as they
+ // want.
MinimumWaitDuration string `json:"minimumWaitDuration,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -304,6 +338,11 @@
// FindFullHashesRequest: Request to return full hashes matched by the
// provided hash prefixes.
type FindFullHashesRequest struct {
+ // ApiClient: Client metadata associated with callers of higher-level
+ // APIs built on top
+ // of the client's implementation.
+ ApiClient *ClientInfo `json:"apiClient,omitempty"`
+
// Client: The client metadata.
Client *ClientInfo `json:"client,omitempty"`
@@ -314,7 +353,7 @@
// ThreatInfo: The lists and hashes to be checked.
ThreatInfo *ThreatInfo `json:"threatInfo,omitempty"`
- // ForceSendFields is a list of field names (e.g. "Client") to
+ // ForceSendFields is a list of field names (e.g. "ApiClient") 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
@@ -322,8 +361,8 @@
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
- // NullFields is a list of field names (e.g. "Client") to include in API
- // requests with the JSON null value. By default, fields with empty
+ // NullFields is a list of field names (e.g. "ApiClient") 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.
@@ -342,12 +381,15 @@
Matches []*ThreatMatch `json:"matches,omitempty"`
// MinimumWaitDuration: The minimum duration the client must wait before
- // issuing any find hashes request. If this field is not set, clients
- // can issue a request as soon as they want.
+ // issuing any find hashes
+ // request. If this field is not set, clients can issue a request as
+ // soon as
+ // they want.
MinimumWaitDuration string `json:"minimumWaitDuration,omitempty"`
// NegativeCacheDuration: For requested entities that did not match the
- // threat list, how long to cache the response.
+ // threat list, how long to
+ // cache the response.
NegativeCacheDuration string `json:"negativeCacheDuration,omitempty"`
// ServerResponse contains the HTTP response code and headers from the
@@ -479,39 +521,44 @@
// list.
//
// Possible values:
- // "PLATFORM_TYPE_UNSPECIFIED"
- // "WINDOWS"
- // "LINUX"
- // "ANDROID"
- // "OSX"
- // "IOS"
- // "ANY_PLATFORM"
- // "ALL_PLATFORMS"
- // "CHROME"
+ // "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
+ // "WINDOWS" - Threat posed to Windows.
+ // "LINUX" - Threat posed to Linux.
+ // "ANDROID" - Threat posed to Android.
+ // "OSX" - Threat posed to OS X.
+ // "IOS" - Threat posed to iOS.
+ // "ANY_PLATFORM" - Threat posed to at least one of the defined
+ // platforms.
+ // "ALL_PLATFORMS" - Threat posed to all defined platforms.
+ // "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// State: The current state of the client for the requested list (the
- // encrypted client state that was received from the last successful
- // list update).
+ // encrypted
+ // client state that was received from the last successful list update).
State string `json:"state,omitempty"`
// ThreatEntryType: The types of entries present in the list.
//
// Possible values:
- // "THREAT_ENTRY_TYPE_UNSPECIFIED"
- // "URL"
- // "EXECUTABLE"
- // "IP_RANGE"
+ // "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
+ // "URL" - A URL.
+ // "EXECUTABLE" - An executable program.
+ // "IP_RANGE" - An IP range.
+ // "CHROME_EXTENSION" - Chrome extension.
+ // "FILENAME" - Filename.
+ // "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The type of threat posed by entries present in the list.
//
// Possible values:
- // "THREAT_TYPE_UNSPECIFIED"
- // "MALWARE"
- // "SOCIAL_ENGINEERING"
- // "UNWANTED_SOFTWARE"
- // "POTENTIALLY_HARMFUL_APPLICATION"
+ // "THREAT_TYPE_UNSPECIFIED" - Unknown.
+ // "MALWARE" - Malware threat type.
+ // "SOCIAL_ENGINEERING" - Social engineering threat type.
+ // "UNWANTED_SOFTWARE" - Unwanted software threat type.
+ // "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
+ // threat type.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Constraints") to
@@ -540,14 +587,19 @@
// ListUpdateResponse: An update to an individual list.
type ListUpdateResponse struct {
// Additions: A set of entries to add to a local threat type's list.
- // Repeated to allow for a combination of compressed and raw data to be
- // sent in a single response.
+ // Repeated to allow
+ // for a combination of compressed and raw data to be sent in a
+ // single
+ // response.
Additions []*ThreatEntrySet `json:"additions,omitempty"`
// Checksum: The expected SHA256 hash of the client state; that is, of
- // the sorted list of all hashes present in the database after applying
- // the provided update. If the client state doesn't match the expected
- // state, the client must disregard this update and retry later.
+ // the sorted list
+ // of all hashes present in the database after applying the provided
+ // update.
+ // If the client state doesn't match the expected state, the client
+ // must
+ // disregard this update and retry later.
Checksum *Checksum `json:"checksum,omitempty"`
// NewClientState: The new client state, in encrypted format. Opaque to
@@ -557,47 +609,59 @@
// PlatformType: The platform type for which data is returned.
//
// Possible values:
- // "PLATFORM_TYPE_UNSPECIFIED"
- // "WINDOWS"
- // "LINUX"
- // "ANDROID"
- // "OSX"
- // "IOS"
- // "ANY_PLATFORM"
- // "ALL_PLATFORMS"
- // "CHROME"
+ // "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
+ // "WINDOWS" - Threat posed to Windows.
+ // "LINUX" - Threat posed to Linux.
+ // "ANDROID" - Threat posed to Android.
+ // "OSX" - Threat posed to OS X.
+ // "IOS" - Threat posed to iOS.
+ // "ANY_PLATFORM" - Threat posed to at least one of the defined
+ // platforms.
+ // "ALL_PLATFORMS" - Threat posed to all defined platforms.
+ // "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// Removals: A set of entries to remove from a local threat type's list.
- // Repeated for the same reason as above.
+ // In practice,
+ // this field is empty or contains exactly one ThreatEntrySet.
Removals []*ThreatEntrySet `json:"removals,omitempty"`
// ResponseType: The type of response. This may indicate that an action
- // is required by the client when the response is received.
+ // is required by the
+ // client when the response is received.
//
// Possible values:
- // "RESPONSE_TYPE_UNSPECIFIED"
- // "PARTIAL_UPDATE"
- // "FULL_UPDATE"
+ // "RESPONSE_TYPE_UNSPECIFIED" - Unknown.
+ // "PARTIAL_UPDATE" - Partial updates are applied to the client's
+ // existing local database.
+ // "FULL_UPDATE" - Full updates replace the client's entire local
+ // database. This means
+ // that either the client was seriously out-of-date or the client
+ // is
+ // believed to be corrupt.
ResponseType string `json:"responseType,omitempty"`
// ThreatEntryType: The format of the threats.
//
// Possible values:
- // "THREAT_ENTRY_TYPE_UNSPECIFIED"
- // "URL"
- // "EXECUTABLE"
- // "IP_RANGE"
+ // "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
+ // "URL" - A URL.
+ // "EXECUTABLE" - An executable program.
+ // "IP_RANGE" - An IP range.
+ // "CHROME_EXTENSION" - Chrome extension.
+ // "FILENAME" - Filename.
+ // "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The threat type for which data is returned.
//
// Possible values:
- // "THREAT_TYPE_UNSPECIFIED"
- // "MALWARE"
- // "SOCIAL_ENGINEERING"
- // "UNWANTED_SOFTWARE"
- // "POTENTIALLY_HARMFUL_APPLICATION"
+ // "THREAT_TYPE_UNSPECIFIED" - Unknown.
+ // "MALWARE" - Malware threat type.
+ // "SOCIAL_ENGINEERING" - Social engineering threat type.
+ // "UNWANTED_SOFTWARE" - Unwanted software threat type.
+ // "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
+ // threat type.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Additions") to
@@ -625,10 +689,12 @@
// MetadataEntry: A single metadata entry.
type MetadataEntry struct {
- // Key: The metadata entry key.
+ // Key: The metadata entry key. For JSON requests, the key is
+ // base64-encoded.
Key string `json:"key,omitempty"`
- // Value: The metadata entry value.
+ // Value: The metadata entry value. For JSON requests, the value is
+ // base64-encoded.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Key") to
@@ -655,20 +721,28 @@
}
// RawHashes: The uncompressed threat entries in hash format of a
-// particular prefix length. Hashes can be anywhere from 4 to 32 bytes
-// in size. A large majority are 4 bytes, but some hashes are lengthened
-// if they collide with the hash of a popular URL. Used for sending
-// ThreatEntrySet to clients that do not support compression, or when
-// sending non-4-byte hashes to clients that do support compression.
+// particular prefix length.
+// Hashes can be anywhere from 4 to 32 bytes in size. A large majority
+// are 4
+// bytes, but some hashes are lengthened if they collide with the hash
+// of a
+// popular URL.
+//
+// Used for sending ThreatEntrySet to clients that do not support
+// compression,
+// or when sending non-4-byte hashes to clients that do support
+// compression.
type RawHashes struct {
- // PrefixSize: The number of bytes for each prefix encoded below. This
- // field can be anywhere from 4 (shortest prefix) to 32 (full SHA256
- // hash).
+ // PrefixSize: The number of bytes for each prefix encoded below. This
+ // field can be
+ // anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
PrefixSize int64 `json:"prefixSize,omitempty"`
- // RawHashes: The hashes, all concatenated into one long string. Each
- // hash has a prefix size of |prefix_size| above. Hashes are sorted in
- // lexicographic order.
+ // RawHashes: The hashes, in binary format, concatenated into one long
+ // string. Hashes are
+ // sorted in lexicographic order. For JSON API users, hashes
+ // are
+ // base64-encoded.
RawHashes string `json:"rawHashes,omitempty"`
// ForceSendFields is a list of field names (e.g. "PrefixSize") to
@@ -724,24 +798,28 @@
}
// RiceDeltaEncoding: The Rice-Golomb encoded data. Used for sending
-// compressed 4-byte hashes or compressed removal indices.
+// compressed 4-byte hashes or
+// compressed removal indices.
type RiceDeltaEncoding struct {
// EncodedData: The encoded deltas that are encoded using the
// Golomb-Rice coder.
EncodedData string `json:"encodedData,omitempty"`
// FirstValue: The offset of the first entry in the encoded data, or, if
- // only a single integer was encoded, that single integer's value.
+ // only a single
+ // integer was encoded, that single integer's value.
FirstValue int64 `json:"firstValue,omitempty,string"`
// NumEntries: The number of entries that are delta encoded in the
- // encoded data. If only a single integer was encoded, this will be zero
- // and the single value will be stored in `first_value`.
+ // encoded data. If only a
+ // single integer was encoded, this will be zero and the single value
+ // will be
+ // stored in `first_value`.
NumEntries int64 `json:"numEntries,omitempty"`
// RiceParameter: The Golomb-Rice parameter, which is a number between 2
- // and 28. This field is missing (that is, zero) if `num_entries` is
- // zero.
+ // and 28. This field
+ // is missing (that is, zero) if `num_entries` is zero.
RiceParameter int64 `json:"riceParameter,omitempty"`
// ForceSendFields is a list of field names (e.g. "EncodedData") to
@@ -768,14 +846,20 @@
}
// ThreatEntry: An individual threat; for example, a malicious URL or
-// its hash representation. Only one of these fields should be set.
+// its hash
+// representation. Only one of these fields should be set.
type ThreatEntry struct {
// Digest: The digest of an executable in SHA256 format. The API
- // supports both binary and hex digests.
+ // supports both
+ // binary and hex digests. For JSON requests, digests are
+ // base64-encoded.
Digest string `json:"digest,omitempty"`
// Hash: A hash prefix, consisting of the most significant 4-32 bytes of
- // a SHA256 hash. This field is in binary format.
+ // a SHA256
+ // hash. This field is in binary format. For JSON requests, hashes
+ // are
+ // base64-encoded.
Hash string `json:"hash,omitempty"`
// Url: A URL.
@@ -805,8 +889,9 @@
}
// ThreatEntryMetadata: The metadata associated with a specific threat
-// entry. The client is expected to know the metadata key/value pairs
-// associated with each threat type.
+// entry. The client is expected
+// to know the metadata key/value pairs associated with each threat
+// type.
type ThreatEntryMetadata struct {
// Entries: The metadata entries.
Entries []*MetadataEntry `json:"entries,omitempty"`
@@ -835,14 +920,15 @@
}
// ThreatEntrySet: A set of threats that should be added or removed from
-// a client's local database.
+// a client's local
+// database.
type ThreatEntrySet struct {
// CompressionType: The compression type for the entries in this set.
//
// Possible values:
- // "COMPRESSION_TYPE_UNSPECIFIED"
- // "RAW"
- // "RICE"
+ // "COMPRESSION_TYPE_UNSPECIFIED" - Unknown.
+ // "RAW" - Raw, uncompressed data.
+ // "RICE" - Rice-Golomb encoded data.
CompressionType string `json:"compressionType,omitempty"`
// RawHashes: The raw SHA256-formatted entries.
@@ -852,12 +938,19 @@
RawIndices *RawIndices `json:"rawIndices,omitempty"`
// RiceHashes: The encoded 4-byte prefixes of SHA256-formatted entries,
- // using a Golomb-Rice encoding.
+ // using a
+ // Golomb-Rice encoding. The hashes are converted to uint32, sorted
+ // in
+ // ascending order, then delta encoded and stored as encoded_data.
RiceHashes *RiceDeltaEncoding `json:"riceHashes,omitempty"`
// RiceIndices: The encoded local, lexicographically-sorted list
- // indices, using a Golomb-Rice encoding. Used for sending compressed
- // removal indices.
+ // indices, using a
+ // Golomb-Rice encoding. Used for sending compressed removal indices.
+ // The
+ // removal indices (uint32) are sorted in ascending order, then delta
+ // encoded
+ // and stored as encoded_data.
RiceIndices *RiceDeltaEncoding `json:"riceIndices,omitempty"`
// ForceSendFields is a list of field names (e.g. "CompressionType") to
@@ -885,7 +978,8 @@
}
// ThreatInfo: The information regarding one or more threats that a
-// client submits when checking for matches in threat lists.
+// client submits when
+// checking for matches in threat lists.
type ThreatInfo struct {
// PlatformTypes: The platform types to be checked.
//
@@ -912,6 +1006,9 @@
// "URL" - A URL.
// "EXECUTABLE" - An executable program.
// "IP_RANGE" - An IP range.
+ // "CHROME_EXTENSION" - Chrome extension.
+ // "FILENAME" - Filename.
+ // "CERT" - CERT
ThreatEntryTypes []string `json:"threatEntryTypes,omitempty"`
// ThreatTypes: The threat types to be checked.
@@ -949,40 +1046,47 @@
}
// ThreatListDescriptor: Describes an individual threat list. A list is
-// defined by three parameters: the type of threat posed, the type of
-// platform targeted by the threat, and the type of entries in the list.
+// defined by three parameters:
+// the type of threat posed, the type of platform targeted by the
+// threat, and
+// the type of entries in the list.
type ThreatListDescriptor struct {
// PlatformType: The platform type targeted by the list's entries.
//
// Possible values:
- // "PLATFORM_TYPE_UNSPECIFIED"
- // "WINDOWS"
- // "LINUX"
- // "ANDROID"
- // "OSX"
- // "IOS"
- // "ANY_PLATFORM"
- // "ALL_PLATFORMS"
- // "CHROME"
+ // "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
+ // "WINDOWS" - Threat posed to Windows.
+ // "LINUX" - Threat posed to Linux.
+ // "ANDROID" - Threat posed to Android.
+ // "OSX" - Threat posed to OS X.
+ // "IOS" - Threat posed to iOS.
+ // "ANY_PLATFORM" - Threat posed to at least one of the defined
+ // platforms.
+ // "ALL_PLATFORMS" - Threat posed to all defined platforms.
+ // "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// ThreatEntryType: The entry types contained in the list.
//
// Possible values:
- // "THREAT_ENTRY_TYPE_UNSPECIFIED"
- // "URL"
- // "EXECUTABLE"
- // "IP_RANGE"
+ // "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
+ // "URL" - A URL.
+ // "EXECUTABLE" - An executable program.
+ // "IP_RANGE" - An IP range.
+ // "CHROME_EXTENSION" - Chrome extension.
+ // "FILENAME" - Filename.
+ // "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The threat type posed by the list's entries.
//
// Possible values:
- // "THREAT_TYPE_UNSPECIFIED"
- // "MALWARE"
- // "SOCIAL_ENGINEERING"
- // "UNWANTED_SOFTWARE"
- // "POTENTIALLY_HARMFUL_APPLICATION"
+ // "THREAT_TYPE_UNSPECIFIED" - Unknown.
+ // "MALWARE" - Malware threat type.
+ // "SOCIAL_ENGINEERING" - Social engineering threat type.
+ // "UNWANTED_SOFTWARE" - Unwanted software threat type.
+ // "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
+ // threat type.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "PlatformType") to
@@ -1012,22 +1116,23 @@
// Browsing threat lists.
type ThreatMatch struct {
// CacheDuration: The cache lifetime for the returned match. Clients
- // must not cache this response for more than this duration to avoid
- // false positives.
+ // must not cache this
+ // response for more than this duration to avoid false positives.
CacheDuration string `json:"cacheDuration,omitempty"`
// PlatformType: The platform type matching this threat.
//
// Possible values:
- // "PLATFORM_TYPE_UNSPECIFIED"
- // "WINDOWS"
- // "LINUX"
- // "ANDROID"
- // "OSX"
- // "IOS"
- // "ANY_PLATFORM"
- // "ALL_PLATFORMS"
- // "CHROME"
+ // "PLATFORM_TYPE_UNSPECIFIED" - Unknown platform.
+ // "WINDOWS" - Threat posed to Windows.
+ // "LINUX" - Threat posed to Linux.
+ // "ANDROID" - Threat posed to Android.
+ // "OSX" - Threat posed to OS X.
+ // "IOS" - Threat posed to iOS.
+ // "ANY_PLATFORM" - Threat posed to at least one of the defined
+ // platforms.
+ // "ALL_PLATFORMS" - Threat posed to all defined platforms.
+ // "CHROME" - Threat posed to Chrome.
PlatformType string `json:"platformType,omitempty"`
// Threat: The threat matching this threat.
@@ -1039,20 +1144,24 @@
// ThreatEntryType: The threat entry type matching this threat.
//
// Possible values:
- // "THREAT_ENTRY_TYPE_UNSPECIFIED"
- // "URL"
- // "EXECUTABLE"
- // "IP_RANGE"
+ // "THREAT_ENTRY_TYPE_UNSPECIFIED" - Unspecified.
+ // "URL" - A URL.
+ // "EXECUTABLE" - An executable program.
+ // "IP_RANGE" - An IP range.
+ // "CHROME_EXTENSION" - Chrome extension.
+ // "FILENAME" - Filename.
+ // "CERT" - CERT
ThreatEntryType string `json:"threatEntryType,omitempty"`
// ThreatType: The threat type matching this threat.
//
// Possible values:
- // "THREAT_TYPE_UNSPECIFIED"
- // "MALWARE"
- // "SOCIAL_ENGINEERING"
- // "UNWANTED_SOFTWARE"
- // "POTENTIALLY_HARMFUL_APPLICATION"
+ // "THREAT_TYPE_UNSPECIFIED" - Unknown.
+ // "MALWARE" - Malware threat type.
+ // "SOCIAL_ENGINEERING" - Social engineering threat type.
+ // "UNWANTED_SOFTWARE" - Unwanted software threat type.
+ // "POTENTIALLY_HARMFUL_APPLICATION" - Potentially harmful application
+ // threat type.
ThreatType string `json:"threatType,omitempty"`
// ForceSendFields is a list of field names (e.g. "CacheDuration") to
@@ -1078,6 +1187,330 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// method id "safebrowsing.encodedFullHashes.get":
+
+type EncodedFullHashesGetCall struct {
+ s *Service
+ encodedRequest string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get:
+func (r *EncodedFullHashesService) Get(encodedRequest string) *EncodedFullHashesGetCall {
+ c := &EncodedFullHashesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.encodedRequest = encodedRequest
+ return c
+}
+
+// ClientId sets the optional parameter "clientId": A client ID that
+// (hopefully) uniquely identifies the client implementation
+// of the Safe Browsing API.
+func (c *EncodedFullHashesGetCall) ClientId(clientId string) *EncodedFullHashesGetCall {
+ c.urlParams_.Set("clientId", clientId)
+ return c
+}
+
+// ClientVersion sets the optional parameter "clientVersion": The
+// version of the client implementation.
+func (c *EncodedFullHashesGetCall) ClientVersion(clientVersion string) *EncodedFullHashesGetCall {
+ c.urlParams_.Set("clientVersion", clientVersion)
+ 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 *EncodedFullHashesGetCall) Fields(s ...googleapi.Field) *EncodedFullHashesGetCall {
+ 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 *EncodedFullHashesGetCall) IfNoneMatch(entityTag string) *EncodedFullHashesGetCall {
+ 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 *EncodedFullHashesGetCall) Context(ctx context.Context) *EncodedFullHashesGetCall {
+ 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 *EncodedFullHashesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *EncodedFullHashesGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v4/encodedFullHashes/{encodedRequest}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "encodedRequest": c.encodedRequest,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "safebrowsing.encodedFullHashes.get" call.
+// Exactly one of *FindFullHashesResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *FindFullHashesResponse.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 *EncodedFullHashesGetCall) Do(opts ...googleapi.CallOption) (*FindFullHashesResponse, 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 := &FindFullHashesResponse{
+ 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": "",
+ // "flatPath": "v4/encodedFullHashes/{encodedRequest}",
+ // "httpMethod": "GET",
+ // "id": "safebrowsing.encodedFullHashes.get",
+ // "parameterOrder": [
+ // "encodedRequest"
+ // ],
+ // "parameters": {
+ // "clientId": {
+ // "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "clientVersion": {
+ // "description": "The version of the client implementation.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "encodedRequest": {
+ // "description": "A serialized FindFullHashesRequest proto.",
+ // "format": "byte",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v4/encodedFullHashes/{encodedRequest}",
+ // "response": {
+ // "$ref": "FindFullHashesResponse"
+ // }
+ // }
+
+}
+
+// method id "safebrowsing.encodedUpdates.get":
+
+type EncodedUpdatesGetCall struct {
+ s *Service
+ encodedRequest string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// Get:
+func (r *EncodedUpdatesService) Get(encodedRequest string) *EncodedUpdatesGetCall {
+ c := &EncodedUpdatesGetCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.encodedRequest = encodedRequest
+ return c
+}
+
+// ClientId sets the optional parameter "clientId": A client ID that
+// uniquely identifies the client implementation of the Safe
+// Browsing API.
+func (c *EncodedUpdatesGetCall) ClientId(clientId string) *EncodedUpdatesGetCall {
+ c.urlParams_.Set("clientId", clientId)
+ return c
+}
+
+// ClientVersion sets the optional parameter "clientVersion": The
+// version of the client implementation.
+func (c *EncodedUpdatesGetCall) ClientVersion(clientVersion string) *EncodedUpdatesGetCall {
+ c.urlParams_.Set("clientVersion", clientVersion)
+ 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 *EncodedUpdatesGetCall) Fields(s ...googleapi.Field) *EncodedUpdatesGetCall {
+ 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 *EncodedUpdatesGetCall) IfNoneMatch(entityTag string) *EncodedUpdatesGetCall {
+ 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 *EncodedUpdatesGetCall) Context(ctx context.Context) *EncodedUpdatesGetCall {
+ 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 *EncodedUpdatesGetCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *EncodedUpdatesGetCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v4/encodedUpdates/{encodedRequest}")
+ urls += "?" + c.urlParams_.Encode()
+ req, _ := http.NewRequest("GET", urls, body)
+ req.Header = reqHeaders
+ googleapi.Expand(req.URL, map[string]string{
+ "encodedRequest": c.encodedRequest,
+ })
+ return gensupport.SendRequest(c.ctx_, c.s.client, req)
+}
+
+// Do executes the "safebrowsing.encodedUpdates.get" call.
+// Exactly one of *FetchThreatListUpdatesResponse or error will be
+// non-nil. Any non-2xx status code is an error. Response headers are in
+// either *FetchThreatListUpdatesResponse.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 *EncodedUpdatesGetCall) Do(opts ...googleapi.CallOption) (*FetchThreatListUpdatesResponse, 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 := &FetchThreatListUpdatesResponse{
+ 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": "",
+ // "flatPath": "v4/encodedUpdates/{encodedRequest}",
+ // "httpMethod": "GET",
+ // "id": "safebrowsing.encodedUpdates.get",
+ // "parameterOrder": [
+ // "encodedRequest"
+ // ],
+ // "parameters": {
+ // "clientId": {
+ // "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "clientVersion": {
+ // "description": "The version of the client implementation.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "encodedRequest": {
+ // "description": "A serialized FetchThreatListUpdatesRequest proto.",
+ // "format": "byte",
+ // "location": "path",
+ // "required": true,
+ // "type": "string"
+ // }
+ // },
+ // "path": "v4/encodedUpdates/{encodedRequest}",
+ // "response": {
+ // "$ref": "FetchThreatListUpdatesResponse"
+ // }
+ // }
+
+}
+
// method id "safebrowsing.fullHashes.find":
type FullHashesFindCall struct {
@@ -1180,8 +1613,11 @@
return ret, nil
// {
// "description": "Finds the full hashes that match the requested hash prefixes.",
+ // "flatPath": "v4/fullHashes:find",
// "httpMethod": "POST",
// "id": "safebrowsing.fullHashes.find",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v4/fullHashes:find",
// "request": {
// "$ref": "FindFullHashesRequest"
@@ -1204,7 +1640,8 @@
}
// Fetch: Fetches the most recent threat list updates. A client can
-// request updates for multiple lists at once.
+// request updates
+// for multiple lists at once.
func (r *ThreatListUpdatesService) Fetch(fetchthreatlistupdatesrequest *FetchThreatListUpdatesRequest) *ThreatListUpdatesFetchCall {
c := &ThreatListUpdatesFetchCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.fetchthreatlistupdatesrequest = fetchthreatlistupdatesrequest
@@ -1295,9 +1732,12 @@
}
return ret, nil
// {
- // "description": "Fetches the most recent threat list updates. A client can request updates for multiple lists at once.",
+ // "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.",
+ // "flatPath": "v4/threatListUpdates:fetch",
// "httpMethod": "POST",
// "id": "safebrowsing.threatListUpdates.fetch",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v4/threatListUpdates:fetch",
// "request": {
// "$ref": "FetchThreatListUpdatesRequest"
@@ -1418,8 +1858,11 @@
return ret, nil
// {
// "description": "Lists the Safe Browsing threat lists available for download.",
+ // "flatPath": "v4/threatLists",
// "httpMethod": "GET",
// "id": "safebrowsing.threatLists.list",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v4/threatLists",
// "response": {
// "$ref": "ListThreatListsResponse"
@@ -1530,8 +1973,11 @@
return ret, nil
// {
// "description": "Finds the threat entries that match the Safe Browsing lists.",
+ // "flatPath": "v4/threatMatches:find",
// "httpMethod": "POST",
// "id": "safebrowsing.threatMatches.find",
+ // "parameterOrder": [],
+ // "parameters": {},
// "path": "v4/threatMatches:find",
// "request": {
// "$ref": "FindThreatMatchesRequest"
diff --git a/script/v1/script-api.json b/script/v1/script-api.json
index 9edd18d..1c0584d 100644
--- a/script/v1/script-api.json
+++ b/script/v1/script-api.json
@@ -1,31 +1,25 @@
{
+ "rootUrl": "https://script.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "script",
+ "batchPath": "batch",
+ "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
+ "revision": "20170228",
+ "id": "script:v1",
+ "title": "Google Apps Script Execution API",
"discoveryVersion": "v1",
"ownerName": "Google",
"resources": {
"scripts": {
"methods": {
"run": {
- "flatPath": "v1/scripts/{scriptId}:run",
- "path": "v1/scripts/{scriptId}:run",
- "id": "script.scripts.run",
- "request": {
- "$ref": "ExecutionRequest"
- },
- "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script 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"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"scriptId"
],
- "httpMethod": "POST",
- "parameters": {
- "scriptId": {
- "location": "path",
- "description": "The project key of the script to be executed. To find the project key, open\nthe project in the script editor and select **File \u003e Project properties**.",
- "required": true,
- "type": "string"
- }
+ "response": {
+ "$ref": "Operation"
},
"scopes": [
"https://mail.google.com/",
@@ -39,16 +33,31 @@
"https://www.googleapis.com/auth/groups",
"https://www.googleapis.com/auth/spreadsheets",
"https://www.googleapis.com/auth/userinfo.email"
- ]
+ ],
+ "parameters": {
+ "scriptId": {
+ "description": "The project key of the script to be executed. To find the project key, open\nthe project in the script editor and select **File \u003e Project properties**.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/scripts/{scriptId}:run",
+ "id": "script.scripts.run",
+ "path": "v1/scripts/{scriptId}: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"
+ }
}
}
}
},
"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.",
@@ -57,32 +66,32 @@
"location": "query"
},
"uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
+ "location": "query"
},
"fields": {
- "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"callback": {
- "type": "string",
"location": "query",
- "description": "JSONP"
+ "description": "JSONP",
+ "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.",
@@ -100,59 +109,110 @@
],
"location": "query"
},
- "key": {
+ "access_token": {
"location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "description": "OAuth access token.",
"type": "string"
},
- "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"
},
"quotaUser": {
+ "location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "description": "OAuth bearer token.",
"type": "string",
"location": "query"
},
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"schemas": {
+ "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",
+ "properties": {
+ "result": {
+ "description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called through the Execution API cannot\nreturn Apps Script-specific objects (such as a `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
+ "type": "any"
+ }
+ },
+ "id": "ExecutionResponse"
+ },
+ "Operation": {
+ "properties": {
+ "done": {
+ "description": "This field is not used.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.",
+ "type": "object"
+ },
+ "name": {
+ "description": "This field is not used.",
+ "type": "string"
+ },
+ "error": {
+ "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this 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.",
+ "$ref": "Status"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "This field is not used.",
+ "type": "object"
+ }
+ },
+ "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": {
- "id": "ScriptStackTraceElement",
"description": "A stack trace through the script that shows where the execution failed.",
"type": "object",
"properties": {
+ "function": {
+ "description": "The name of the function that failed.",
+ "type": "string"
+ },
"lineNumber": {
"description": "The line number where the script failed.",
"format": "int32",
"type": "integer"
- },
- "function": {
- "description": "The name of the function that failed.",
- "type": "string"
}
- }
+ },
+ "id": "ScriptStackTraceElement"
},
"ExecutionError": {
- "description": "An object that provides information about the nature of an error in the Apps\nScript Execution API. If an\n`run` call succeeds but the\nscript function (or Apps Script itself) throws an exception, the response\nbody's `error` field contains a\n`Status` object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
- "type": "object",
"properties": {
+ "scriptStackTraceElements": {
+ "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
+ "type": "array",
+ "items": {
+ "$ref": "ScriptStackTraceElement"
+ }
+ },
"errorType": {
"description": "The error type, for example `TypeError` or `ReferenceError`. If the error\ntype is unavailable, this field is not included.",
"type": "string"
@@ -160,21 +220,20 @@
"errorMessage": {
"description": "The error message thrown by Apps Script, usually localized into the user's\nlanguage.",
"type": "string"
- },
- "scriptStackTraceElements": {
- "description": "An array of objects that provide a stack trace through the script to show\nwhere the execution failed, with the deepest call first.",
- "type": "array",
- "items": {
- "$ref": "ScriptStackTraceElement"
- }
}
},
- "id": "ExecutionError"
+ "id": "ExecutionError",
+ "description": "An object that provides information about the nature of an error in the Apps\nScript Execution API. If an\n`run` call succeeds but the\nscript function (or Apps Script itself) throws an exception, the response\nbody's `error` field contains a\n`Status` object. The `Status` object's `details` field\ncontains an array with a single one of these `ExecutionError` objects.",
+ "type": "object"
},
"Status": {
"description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's `error` field will contain this `Status` object.",
"type": "object",
"properties": {
+ "message": {
+ "description": "A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [`google.rpc.Status.details`](google.rpc.Status.details) field, or localized by the client.",
+ "type": "string"
+ },
"details": {
"description": "An array that contains a single `ExecutionError` object that provides information about the nature of the error.",
"type": "array",
@@ -190,17 +249,11 @@
"description": "The status code. For this API, this value will always be 3, corresponding to an INVALID_ARGUMENT 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": {
- "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.",
- "type": "object",
"properties": {
"function": {
"description": "The name of the function to execute in the given script. The name does not\ninclude parentheses or parameters.",
@@ -222,65 +275,30 @@
"type": "string"
}
},
- "id": "ExecutionRequest"
- },
- "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",
- "properties": {
- "result": {
- "description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called through the Execution API cannot\nreturn Apps Script-specific objects (such as a `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.",
- "type": "any"
- }
- },
- "id": "ExecutionResponse"
- },
- "Operation": {
- "type": "object",
- "properties": {
- "response": {
- "description": "If the script function returns successfully, this field will contain an `ExecutionResponse` object with the function's return value as the object's `result` field.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "This field is not used.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this 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."
- },
- "metadata": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "This field is not used.",
- "type": "object"
- },
- "done": {
- "description": "This field is not used.",
- "type": "boolean"
- }
- },
- "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"
+ "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": {
"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://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"
+ },
"https://www.googleapis.com/auth/forms.currentonly": {
"description": "View and manage forms that this application has been installed in"
},
@@ -297,36 +315,18 @@
"description": "View and manage your spreadsheets in Google Drive"
},
"https://mail.google.com/": {
- "description": "View and manage your mail"
+ "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"
- },
- "https://www.googleapis.com/auth/groups": {
- "description": "View and manage your Google Groups"
}
}
}
},
- "servicePath": "",
- "description": "Executes Google Apps Script projects.",
"kind": "discovery#restDescription",
- "rootUrl": "https://script.googleapis.com/",
- "basePath": "",
- "ownerDomain": "google.com",
- "name": "script",
- "batchPath": "batch",
- "revision": "20170301",
- "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run",
- "id": "script:v1",
- "title": "Google Apps Script Execution API"
+ "description": "Executes Google Apps Script projects.",
+ "servicePath": ""
}
diff --git a/script/v1/script-gen.go b/script/v1/script-gen.go
index 7584026..b6da1e8 100644
--- a/script/v1/script-gen.go
+++ b/script/v1/script-gen.go
@@ -47,7 +47,7 @@
// OAuth2 scopes used by this API.
const (
- // View and manage your mail
+ // Read, send, delete, and manage your email
MailGoogleComScope = "https://mail.google.com/"
// Manage your calendars
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json
index 5553d8c..48e2cef 100644
--- a/searchconsole/v1/searchconsole-api.json
+++ b/searchconsole/v1/searchconsole-api.json
@@ -1,41 +1,23 @@
{
- "version": "v1",
- "baseUrl": "https://searchconsole.googleapis.com/",
- "canonicalName": "Search Console",
- "servicePath": "",
- "description": "Provides tools for running validation tests against single URLs",
- "kind": "discovery#restDescription",
- "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": "20170305",
- "title": "Google Search Console URL Testing Tools API",
- "ownerName": "Google",
- "discoveryVersion": "v1",
- "version_module": "True",
"resources": {
"urlTestingTools": {
"resources": {
"mobileFriendlyTest": {
"methods": {
"run": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "RunMobileFriendlyTestResponse"
- },
- "parameters": {},
- "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run",
- "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
"path": "v1/urlTestingTools/mobileFriendlyTest:run",
+ "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run",
"description": "Runs Mobile-Friendly Test for a given URL.",
"request": {
"$ref": "RunMobileFriendlyTestRequest"
- }
+ },
+ "response": {
+ "$ref": "RunMobileFriendlyTestResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "parameters": {},
+ "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run"
}
}
}
@@ -49,22 +31,22 @@
"type": "string"
},
"fields": {
+ "location": "query",
"description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"callback": {
"description": "JSONP",
@@ -72,6 +54,8 @@
"location": "query"
},
"alt": {
+ "description": "Data format for response.",
+ "default": "json",
"enum": [
"json",
"media",
@@ -83,9 +67,7 @@
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
+ "location": "query"
},
"key": {
"location": "query",
@@ -93,9 +75,9 @@
"type": "string"
},
"access_token": {
- "location": "query",
"description": "OAuth access token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
@@ -103,18 +85,18 @@
"location": "query"
},
"pp": {
- "location": "query",
"description": "Pretty-print response.",
"type": "boolean",
- "default": "true"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
+ "default": "true",
"location": "query"
},
"bearer_token": {
+ "location": "query",
"description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
@@ -124,13 +106,96 @@
"location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
}
},
"schemas": {
+ "MobileFriendlyIssue": {
+ "properties": {
+ "rule": {
+ "enum": [
+ "MOBILE_FRIENDLY_RULE_UNSPECIFIED",
+ "USES_INCOMPATIBLE_PLUGINS",
+ "CONFIGURE_VIEWPORT",
+ "FIXED_WIDTH_VIEWPORT",
+ "SIZE_CONTENT_TO_VIEWPORT",
+ "USE_LEGIBLE_FONT_SIZES",
+ "TAP_TARGETS_TOO_CLOSE"
+ ],
+ "description": "Rule violated.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown rule. Sorry, we don't have any description for the rule that was\nbroken.",
+ "Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage).",
+ "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).",
+ "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).",
+ "Content not sized to viewport. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).",
+ "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size).",
+ "Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)."
+ ]
+ }
+ },
+ "id": "MobileFriendlyIssue",
+ "description": "Mobile-friendly issue.",
+ "type": "object"
+ },
+ "RunMobileFriendlyTestResponse": {
+ "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": {
+ "$ref": "TestStatus",
+ "description": "Final state of the test, can be either complete or an error."
+ },
+ "resourceIssues": {
+ "description": "Information about embedded resources issues.",
+ "type": "array",
+ "items": {
+ "$ref": "ResourceIssue"
+ }
+ },
+ "mobileFriendliness": {
+ "enum": [
+ "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
+ "MOBILE_FRIENDLY",
+ "NOT_MOBILE_FRIENDLY"
+ ],
+ "description": "Test verdict, whether the page is mobile friendly or not.",
+ "type": "string",
+ "enumDescriptions": [
+ "Internal error when running this test. Please try running the test again.",
+ "The page is mobile friendly.",
+ "The page is not mobile friendly."
+ ]
+ },
+ "mobileFriendlyIssues": {
+ "description": "List of mobile-usability issues.",
+ "type": "array",
+ "items": {
+ "$ref": "MobileFriendlyIssue"
+ }
+ }
+ },
+ "id": "RunMobileFriendlyTestResponse"
+ },
+ "ResourceIssue": {
+ "description": "Information about a resource with issue.",
+ "type": "object",
+ "properties": {
+ "blockedResource": {
+ "description": "Describes a blocked resource issue.",
+ "$ref": "BlockedResource"
+ }
+ },
+ "id": "ResourceIssue"
+ },
"BlockedResource": {
"description": "Blocked resource.",
"type": "object",
@@ -146,7 +211,17 @@
"description": "Final state of the test, including error details if necessary.",
"type": "object",
"properties": {
+ "details": {
+ "description": "Error details if applicable.",
+ "type": "string"
+ },
"status": {
+ "enum": [
+ "TEST_STATUS_UNSPECIFIED",
+ "COMPLETE",
+ "INTERNAL_ERROR",
+ "PAGE_UNREACHABLE"
+ ],
"description": "Status of the test.",
"type": "string",
"enumDescriptions": [
@@ -154,24 +229,12 @@
"Inspection has completed without errors.",
"Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.",
"Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected."
- ],
- "enum": [
- "TEST_STATUS_UNSPECIFIED",
- "COMPLETE",
- "INTERNAL_ERROR",
- "PAGE_UNREACHABLE"
]
- },
- "details": {
- "description": "Error details if applicable.",
- "type": "string"
}
},
"id": "TestStatus"
},
"Image": {
- "description": "Describe image data.",
- "type": "object",
"properties": {
"mimeType": {
"description": "The mime-type of the image data.",
@@ -183,110 +246,47 @@
"type": "string"
}
},
- "id": "Image"
+ "id": "Image",
+ "description": "Describe image data.",
+ "type": "object"
},
"RunMobileFriendlyTestRequest": {
"description": "Mobile-friendly test request.",
"type": "object",
"properties": {
- "requestScreenshot": {
- "description": "Whether or not screenshot is requested. Default is false.",
- "type": "boolean"
- },
"url": {
"description": "URL for inspection.",
"type": "string"
+ },
+ "requestScreenshot": {
+ "description": "Whether or not screenshot is requested. Default is false.",
+ "type": "boolean"
}
},
"id": "RunMobileFriendlyTestRequest"
- },
- "MobileFriendlyIssue": {
- "description": "Mobile-friendly issue.",
- "type": "object",
- "properties": {
- "rule": {
- "enumDescriptions": [
- "Unknown rule. Sorry, we don't have any description for the rule that was\nbroken.",
- "Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage).",
- "Viewsport is not specified using the meta viewport tag. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#viewport_not_configured).",
- "Viewport defined to a fixed width. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).",
- "Content not sized to viewport. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).",
- "Font size is too small for easy reading on a small screen. [Learn More]\n(https://support.google.com/webmasters/answer/6352293#small_font_size).",
- "Touch elements are too close to each other. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#touch_elements_too_close)."
- ],
- "enum": [
- "MOBILE_FRIENDLY_RULE_UNSPECIFIED",
- "USES_INCOMPATIBLE_PLUGINS",
- "CONFIGURE_VIEWPORT",
- "FIXED_WIDTH_VIEWPORT",
- "SIZE_CONTENT_TO_VIEWPORT",
- "USE_LEGIBLE_FONT_SIZES",
- "TAP_TARGETS_TOO_CLOSE"
- ],
- "description": "Rule violated.",
- "type": "string"
- }
- },
- "id": "MobileFriendlyIssue"
- },
- "RunMobileFriendlyTestResponse": {
- "properties": {
- "mobileFriendliness": {
- "description": "Test verdict, whether the page is mobile friendly or not.",
- "type": "string",
- "enumDescriptions": [
- "Internal error when running this test. Please try running the test again.",
- "The page is mobile friendly.",
- "The page is not mobile friendly."
- ],
- "enum": [
- "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED",
- "MOBILE_FRIENDLY",
- "NOT_MOBILE_FRIENDLY"
- ]
- },
- "mobileFriendlyIssues": {
- "description": "List of mobile-usability issues.",
- "type": "array",
- "items": {
- "$ref": "MobileFriendlyIssue"
- }
- },
- "screenshot": {
- "$ref": "Image",
- "description": "Screenshot of the requested URL."
- },
- "testStatus": {
- "$ref": "TestStatus",
- "description": "Final state of the test, can be either complete or an error."
- },
- "resourceIssues": {
- "description": "Information about embedded resources issues.",
- "type": "array",
- "items": {
- "$ref": "ResourceIssue"
- }
- }
- },
- "id": "RunMobileFriendlyTestResponse",
- "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.",
- "type": "object"
- },
- "ResourceIssue": {
- "properties": {
- "blockedResource": {
- "description": "Describes a blocked resource issue.",
- "$ref": "BlockedResource"
- }
- },
- "id": "ResourceIssue",
- "description": "Information about a resource with issue.",
- "type": "object"
}
},
+ "protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
- "protocol": "rest"
+ "version": "v1",
+ "baseUrl": "https://searchconsole.googleapis.com/",
+ "canonicalName": "Search Console",
+ "servicePath": "",
+ "description": "Provides tools for running validation tests against single URLs",
+ "kind": "discovery#restDescription",
+ "rootUrl": "https://searchconsole.googleapis.com/",
+ "basePath": "",
+ "ownerDomain": "google.com",
+ "name": "searchconsole",
+ "batchPath": "batch",
+ "revision": "20170307",
+ "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",
+ "version_module": "True"
}
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json
index ccb0b3c..0543518 100644
--- a/servicecontrol/v1/servicecontrol-api.json
+++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,371 +1,10 @@
{
- "resources": {
- "services": {
- "methods": {
- "endReconciliation": {
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "EndReconciliationResponse"
- },
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:endReconciliation",
- "id": "servicecontrol.services.endReconciliation",
- "path": "v1/services/{serviceName}: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": {
- "id": "servicecontrol.services.report",
- "path": "v1/services/{serviceName}:report",
- "request": {
- "$ref": "ReportRequest"
- },
- "description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ReportResponse"
- },
- "parameters": {
- "serviceName": {
- "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:report"
- },
- "allocateQuota": {
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "AllocateQuotaResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}:allocateQuota",
- "id": "servicecontrol.services.allocateQuota",
- "path": "v1/services/{serviceName}:allocateQuota",
- "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[Google Cloud IAM](https://cloud.google.com/iam).",
- "request": {
- "$ref": "AllocateQuotaRequest"
- }
- },
- "startReconciliation": {
- "response": {
- "$ref": "StartReconciliationResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}: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": {
- "response": {
- "$ref": "CheckResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:check",
- "path": "v1/services/{serviceName}:check",
- "id": "servicecontrol.services.check",
- "request": {
- "$ref": "CheckRequest"
- },
- "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the `CheckRequest` has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
- },
- "releaseQuota": {
- "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[Google Cloud IAM](https://cloud.google.com/iam).",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
- "response": {
- "$ref": "ReleaseQuotaResponse"
- },
- "parameters": {
- "serviceName": {
- "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/servicecontrol"
- ],
- "flatPath": "v1/services/{serviceName}:releaseQuota",
- "id": "servicecontrol.services.releaseQuota",
- "path": "v1/services/{serviceName}:releaseQuota"
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "access_token": {
- "location": "query",
- "description": "OAuth access token.",
- "type": "string"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "quotaUser": {
- "location": "query",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://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": "",
- "id": "servicecontrol:v1",
"revision": "20170224",
"documentationLink": "https://cloud.google.com/service-control/",
+ "id": "servicecontrol:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "AllocateQuotaRequest": {
- "description": "Request message for the AllocateQuota method.",
- "type": "object",
- "properties": {
- "allocateOperation": {
- "description": "Operation that describes the quota allocation.",
- "$ref": "QuotaOperation"
- },
- "allocationMode": {
- "enum": [
- "UNSPECIFIED",
- "NORMAL",
- "BEST_EFFORT",
- "CHECK_ONLY"
- ],
- "description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
- "type": "string",
- "enumDescriptions": [
- "",
- "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
- "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
- "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
- ]
- },
- "serviceConfigId": {
- "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
- "type": "string"
- }
- },
- "id": "AllocateQuotaRequest"
- },
- "ReleaseQuotaResponse": {
- "properties": {
- "releaseErrors": {
- "description": "Indicates the decision of the release.",
- "type": "array",
- "items": {
- "$ref": "QuotaError"
- }
- },
- "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\"",
- "type": "array",
- "items": {
- "$ref": "MetricValueSet"
- }
- },
- "operationId": {
- "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes.",
- "type": "string"
- },
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
- }
- },
- "id": "ReleaseQuotaResponse",
- "description": "Response message for the ReleaseQuota method.",
- "type": "object"
- },
- "MetricValueSet": {
- "properties": {
- "metricName": {
- "description": "The metric name defined in the service configuration.",
- "type": "string"
- },
- "metricValues": {
- "description": "The values in this metric.",
- "type": "array",
- "items": {
- "$ref": "MetricValue"
- }
- }
- },
- "id": "MetricValueSet",
- "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
- "type": "object"
- },
- "ReportError": {
- "description": "Represents the processing error of one `Operation` in the request.",
- "type": "object",
- "properties": {
- "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"
- },
"StartReconciliationRequest": {
"type": "object",
"properties": {
@@ -381,11 +20,9 @@
"id": "StartReconciliationRequest"
},
"CheckError": {
+ "description": "Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.",
+ "type": "object",
"properties": {
- "detail": {
- "description": "Free-form text providing details on the error cause of the error.",
- "type": "string"
- },
"code": {
"enum": [
"ERROR_CODE_UNSPECIFIED",
@@ -457,14 +94,25 @@
"Cloud Resource Manager backend server is unavailable.",
"Backend server for evaluating security policy is unavailable."
]
+ },
+ "detail": {
+ "description": "Free-form text providing details on the error cause of the error.",
+ "type": "string"
}
},
- "id": "CheckError",
- "description": "Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.",
- "type": "object"
+ "id": "CheckError"
},
"QuotaInfo": {
+ "description": "Contains the quota information for a quota check response.",
+ "type": "object",
"properties": {
+ "limitExceeded": {
+ "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"quotaConsumed": {
"additionalProperties": {
"format": "int32",
@@ -479,30 +127,19 @@
"items": {
"$ref": "MetricValueSet"
}
- },
- "limitExceeded": {
- "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
- "id": "QuotaInfo",
- "description": "Contains the quota information for a quota check response.",
- "type": "object"
+ "id": "QuotaInfo"
},
"CheckRequest": {
- "description": "Request message for the Check method.",
- "type": "object",
"properties": {
"skipActivationCheck": {
"description": "Indicates if service activation check should be skipped for this request.\nDefault behavior is to perform the check and apply relevant quota.",
"type": "boolean"
},
"operation": {
- "description": "The operation to be checked.",
- "$ref": "Operation"
+ "$ref": "Operation",
+ "description": "The operation to be checked."
},
"requestProjectSettings": {
"description": "Requests the project settings to be returned as part of the check response.",
@@ -513,13 +150,23 @@
"type": "string"
}
},
- "id": "CheckRequest"
+ "id": "CheckRequest",
+ "description": "Request message for the Check method.",
+ "type": "object"
},
"QuotaOperation": {
- "description": "Represents information regarding a quota operation.",
"type": "object",
"properties": {
+ "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 must be unique within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls should carry the\nsame ID.\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": {
+ "type": "string",
"enumDescriptions": [
"",
"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.\nFor ReleaseQuota request, this mode is supported only for precise quota\nlimits. In this case, this operation releases quota for the amount\nspecified in the service configuration or specified using the quota\nmetrics. If the release can make available quota negative, release error\nwill be returned and no quota will be released.",
@@ -532,8 +179,7 @@
"BEST_EFFORT",
"CHECK_ONLY"
],
- "description": "Quota mode for this operation.",
- "type": "string"
+ "description": "Quota mode for this operation."
},
"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",
@@ -552,24 +198,17 @@
},
"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 must be unique within the scope of the\nservice that generated the operation. If the service calls AllocateQuota\nand ReleaseQuota on the same operation, the two calls should carry the\nsame ID.\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"
}
},
- "id": "QuotaOperation"
+ "id": "QuotaOperation",
+ "description": "Represents information regarding a quota operation."
},
"EndReconciliationRequest": {
"type": "object",
"properties": {
"reconciliationOperation": {
- "$ref": "QuotaOperation",
- "description": "Operation that describes the quota reconciliation."
+ "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.",
@@ -581,26 +220,22 @@
"ReportInfo": {
"type": "object",
"properties": {
+ "quotaInfo": {
+ "description": "Quota usage info when processing the `Operation`.",
+ "$ref": "QuotaInfo"
+ },
"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"
},
"ReportResponse": {
+ "id": "ReportResponse",
+ "description": "Response message for the Report method.",
+ "type": "object",
"properties": {
- "reportErrors": {
- "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.",
- "type": "array",
- "items": {
- "$ref": "ReportError"
- }
- },
"reportInfos": {
"description": "Quota usage for each quota release `Operation` request.\n\nFully or partially failed quota release request may or may not be present\nin `report_quota_info`. For example, a failed quota release request will\nhave the current quota usage info when precise quota library returns the\ninfo. A deadline exceeded quota request will not have quota usage info.\n\nIf there is no quota release request, report_quota_info will be empty.\n",
"type": "array",
@@ -611,20 +246,55 @@
"serviceConfigId": {
"description": "The actual config id used to process the request.",
"type": "string"
+ },
+ "reportErrors": {
+ "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.",
+ "type": "array",
+ "items": {
+ "$ref": "ReportError"
+ }
}
- },
- "id": "ReportResponse",
- "description": "Response message for the Report method.",
- "type": "object"
+ }
},
"Operation": {
+ "type": "object",
"properties": {
+ "startTime": {
+ "description": "Required. Start time of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "importance": {
+ "enumDescriptions": [
+ "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
+ "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
+ "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
+ ],
+ "enum": [
+ "LOW",
+ "HIGH",
+ "DEBUG"
+ ],
+ "description": "DO NOT USE. This is an experimental field.",
+ "type": "string"
+ },
+ "resourceContainer": {
+ "description": "The 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"
+ },
"logEntries": {
- "description": "Represents information to be logged.",
"type": "array",
"items": {
"$ref": "LogEntry"
- }
+ },
+ "description": "Represents information to be logged."
},
"userLabels": {
"additionalProperties": {
@@ -641,8 +311,8 @@
}
},
"quotaProperties": {
- "$ref": "QuotaProperties",
- "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request."
+ "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request.",
+ "$ref": "QuotaProperties"
},
"consumerId": {
"description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.",
@@ -660,43 +330,15 @@
"description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.",
"format": "google-datetime",
"type": "string"
- },
- "startTime": {
- "description": "Required. Start time of the operation.",
- "format": "google-datetime",
- "type": "string"
- },
- "importance": {
- "enum": [
- "LOW",
- "HIGH",
- "DEBUG"
- ],
- "description": "DO NOT USE. This is an experimental field.",
- "type": "string",
- "enumDescriptions": [
- "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.",
- "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.",
- "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level."
- ]
- },
- "resourceContainer": {
- "description": "The resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”",
- "type": "string"
- },
- "labels": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).",
- "type": "object"
}
},
"id": "Operation",
- "description": "Represents information regarding an operation.",
- "type": "object"
+ "description": "Represents information regarding an operation."
},
"CheckResponse": {
+ "id": "CheckResponse",
+ "description": "Response message for the Check method.",
+ "type": "object",
"properties": {
"operationId": {
"description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.",
@@ -721,10 +363,34 @@
"description": "The actual config id used to process the request.",
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "type": "object"
+ },
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use."
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
},
- "id": "CheckResponse",
- "description": "Response message for the Check method.",
- "type": "object"
+ "id": "Status"
},
"ReportRequest": {
"properties": {
@@ -744,35 +410,96 @@
"description": "Request message for the Report method.",
"type": "object"
},
- "Status": {
+ "AuditLog": {
+ "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
+ "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"
+ "requestMetadata": {
+ "description": "Metadata about the operation.",
+ "$ref": "RequestMetadata"
},
- "details": {
- "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "serviceData": {
+ "description": "Other service-specific data about the request, response, and other\nactivities.",
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
}
},
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
+ "numResponseItems": {
+ "description": "The number of items returned from a List or Query API method,\nif applicable.",
+ "format": "int64",
+ "type": "string"
+ },
+ "authenticationInfo": {
+ "$ref": "AuthenticationInfo",
+ "description": "Authentication information."
+ },
+ "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"
+ },
+ "methodName": {
+ "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"",
+ "type": "string"
+ },
+ "resourceName": {
+ "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
+ "type": "string"
+ },
+ "authorizationInfo": {
+ "type": "array",
+ "items": {
+ "$ref": "AuthorizationInfo"
+ },
+ "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"
+ }
}
},
- "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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": "AuditLog"
},
"LogEntry": {
+ "type": "object",
"properties": {
+ "insertId": {
+ "type": "string",
+ "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id."
+ },
+ "name": {
+ "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.",
+ "type": "string"
+ },
+ "structPayload": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object."
+ },
+ "textPayload": {
+ "description": "The log entry payload, represented as a Unicode string (UTF-8).",
+ "type": "string"
+ },
"protoPayload": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
@@ -794,6 +521,17 @@
"type": "object"
},
"severity": {
+ "enumDescriptions": [
+ "(0) The log entry has no assigned severity level.",
+ "(100) Debug or trace information.",
+ "(200) Routine information, such as ongoing status or performance.",
+ "(300) Normal but significant events, such as start up, shut down, or\na configuration change.",
+ "(400) Warning events might cause problems.",
+ "(500) Error events are likely to cause problems.",
+ "(600) Critical events cause more severe problems or outages.",
+ "(700) A person must take an action immediately.",
+ "(800) One or more systems are unusable."
+ ],
"enum": [
"DEFAULT",
"DEBUG",
@@ -806,131 +544,16 @@
"EMERGENCY"
],
"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."
- ]
- },
- "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"
}
},
"id": "LogEntry",
- "description": "An individual log entry.",
- "type": "object"
- },
- "AuditLog": {
- "properties": {
- "serviceData": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "Other service-specific data about the request, response, and other\nactivities.",
- "type": "object"
- },
- "requestMetadata": {
- "$ref": "RequestMetadata",
- "description": "Metadata about the operation."
- },
- "numResponseItems": {
- "description": "The number of items returned from a List or Query API method,\nif applicable.",
- "format": "int64",
- "type": "string"
- },
- "status": {
- "description": "The status of the overall operation.",
- "$ref": "Status"
- },
- "authenticationInfo": {
- "$ref": "AuthenticationInfo",
- "description": "Authentication information."
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- },
- "serviceName": {
- "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.",
- "type": "string"
- },
- "methodName": {
- "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"",
- "type": "string"
- },
- "resourceName": {
- "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"",
- "type": "string"
- },
- "authorizationInfo": {
- "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.",
- "type": "array",
- "items": {
- "$ref": "AuthorizationInfo"
- }
- },
- "request": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.",
- "type": "object"
- }
- },
- "id": "AuditLog",
- "description": "Common audit log format for Google Cloud Platform API operations.\n\n",
- "type": "object"
+ "description": "An individual log entry."
},
"MetricValue": {
+ "description": "Represents a single metric value.",
+ "type": "object",
"properties": {
- "doubleValue": {
- "description": "A double precision floating point value.",
- "format": "double",
- "type": "number"
- },
- "int64Value": {
- "description": "A signed 64-bit integer value.",
- "format": "int64",
- "type": "string"
- },
- "distributionValue": {
- "$ref": "Distribution",
- "description": "A distribution value."
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- },
"endTime": {
"description": "The end of the time period over which this metric value's measurement\napplies.",
"format": "google-datetime",
@@ -950,41 +573,40 @@
"type": "string"
},
"labels": {
+ "type": "object",
"additionalProperties": {
"type": "string"
},
- "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.",
- "type": "object"
- }
- },
- "id": "MetricValue",
- "description": "Represents a single metric value.",
- "type": "object"
- },
- "Money": {
- "properties": {
- "currencyCode": {
- "description": "The 3-letter currency code defined in ISO 4217.",
- "type": "string"
+ "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship."
},
- "nanos": {
- "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
- "format": "int32",
- "type": "integer"
+ "doubleValue": {
+ "description": "A double precision floating point value.",
+ "format": "double",
+ "type": "number"
},
- "units": {
- "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "int64Value": {
+ "description": "A signed 64-bit integer value.",
"format": "int64",
"type": "string"
+ },
+ "distributionValue": {
+ "description": "A distribution value.",
+ "$ref": "Distribution"
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
}
},
- "id": "Money",
- "description": "Represents an amount of money with its currency type.",
- "type": "object"
+ "id": "MetricValue"
},
"EndReconciliationResponse": {
"type": "object",
"properties": {
+ "serviceConfigId": {
+ "description": "ID of the actual config used to process the request.",
+ "type": "string"
+ },
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the adjustment was made.",
"type": "array",
@@ -1002,44 +624,34 @@
"items": {
"$ref": "QuotaError"
}
- },
- "serviceConfigId": {
- "description": "ID of the actual config used to process the request.",
- "type": "string"
}
},
"id": "EndReconciliationResponse"
},
- "ExplicitBuckets": {
- "description": "Describing buckets with arbitrary user-provided width.",
- "type": "object",
+ "Money": {
"properties": {
- "bounds": {
- "description": "'bound' is a list of strictly increasing boundaries between\nbuckets. Note that a list of length N-1 defines N buckets because\nof fenceposting. See comments on `bucket_options` for details.\n\nThe i'th finite bucket covers the interval\n [bound[i-1], bound[i])\nwhere i ranges from 1 to bound_size() - 1. Note that there are no\nfinite buckets at all if 'bound' only contains a single element; in\nthat special case the single bound defines the boundary between the\nunderflow and overflow buckets.\n\nbucket number lower bound upper bound\n i == 0 (underflow) -inf bound[i]\n 0 \u003c i \u003c bound_size() bound[i-1] bound[i]\n i == bound_size() (overflow) bound[i-1] +inf",
- "type": "array",
- "items": {
- "format": "double",
- "type": "number"
- }
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "units": {
+ "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ },
+ "currencyCode": {
+ "description": "The 3-letter currency code defined in ISO 4217.",
+ "type": "string"
}
},
- "id": "ExplicitBuckets"
+ "id": "Money",
+ "description": "Represents an amount of money with its currency type.",
+ "type": "object"
},
"Distribution": {
+ "type": "object",
"properties": {
- "exponentialBuckets": {
- "$ref": "ExponentialBuckets",
- "description": "Buckets with exponentially growing width."
- },
- "linearBuckets": {
- "$ref": "LinearBuckets",
- "description": "Buckets with constant width."
- },
- "minimum": {
- "description": "The minimum of the population of values. Ignored if `count` is zero.",
- "format": "double",
- "type": "number"
- },
"mean": {
"description": "The arithmetic mean of the samples in the distribution. If `count` is\nzero then this field must be zero.",
"format": "double",
@@ -1071,28 +683,55 @@
"description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.",
"format": "double",
"type": "number"
+ },
+ "exponentialBuckets": {
+ "description": "Buckets with exponentially growing width.",
+ "$ref": "ExponentialBuckets"
+ },
+ "minimum": {
+ "type": "number",
+ "description": "The minimum of the population of values. Ignored if `count` is zero.",
+ "format": "double"
+ },
+ "linearBuckets": {
+ "description": "Buckets with constant width.",
+ "$ref": "LinearBuckets"
}
},
"id": "Distribution",
- "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points",
- "type": "object"
+ "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": {
+ "description": "Describing buckets with arbitrary user-provided width.",
+ "type": "object",
+ "properties": {
+ "bounds": {
+ "type": "array",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "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"
},
"ExponentialBuckets": {
"description": "Describing buckets with exponentially growing width.",
"type": "object",
"properties": {
- "scale": {
- "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
- "format": "double",
- "type": "number"
- },
"numFiniteBuckets": {
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
"format": "int32",
"type": "integer"
},
"growthFactor": {
+ "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.",
+ "format": "double"
+ },
+ "scale": {
+ "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.",
"format": "double",
"type": "number"
}
@@ -1119,6 +758,8 @@
"id": "AuthorizationInfo"
},
"StartReconciliationResponse": {
+ "id": "StartReconciliationResponse",
+ "type": "object",
"properties": {
"quotaMetrics": {
"description": "Metric values as tracked by One Platform before the start of\nreconciliation.",
@@ -1128,8 +769,8 @@
}
},
"operationId": {
- "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.",
- "type": "string"
+ "type": "string",
+ "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes."
},
"reconciliationErrors": {
"description": "Indicates the decision of the reconciliation start.",
@@ -1142,11 +783,11 @@
"description": "ID of the actual config used to process the request.",
"type": "string"
}
- },
- "id": "StartReconciliationResponse",
- "type": "object"
+ }
},
"QuotaProperties": {
+ "description": "Represents the properties needed for quota operations.\n\nUse the metric_value_sets field in Operation message to provide cost\noverride with metric_name in \u003cservice_name\u003e/quota/\u003cquota_group_name\u003e/cost\nformat. Overrides for unmatched quota groups will be ignored.\nCosts are expected to be \u003e= 0. Cost 0 will cause no quota check,\nbut still traffic restrictions will be enforced.",
+ "type": "object",
"properties": {
"quotaMode": {
"enum": [
@@ -1172,12 +813,18 @@
"type": "object"
}
},
- "id": "QuotaProperties",
- "description": "Represents the properties needed for quota operations.\n\nUse the metric_value_sets field in Operation message to provide cost\noverride with metric_name in \u003cservice_name\u003e/quota/\u003cquota_group_name\u003e/cost\nformat. Overrides for unmatched quota groups will be ignored.\nCosts are expected to be \u003e= 0. Cost 0 will cause no quota check,\nbut still traffic restrictions will be enforced.",
- "type": "object"
+ "id": "QuotaProperties"
},
"LinearBuckets": {
+ "id": "LinearBuckets",
+ "description": "Describing buckets with constant width.",
+ "type": "object",
"properties": {
+ "offset": {
+ "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
+ "format": "double",
+ "type": "number"
+ },
"numFiniteBuckets": {
"description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.",
"format": "int32",
@@ -1187,33 +834,27 @@
"description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.",
"format": "double",
"type": "number"
- },
- "offset": {
- "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.",
- "format": "double",
- "type": "number"
}
- },
- "id": "LinearBuckets",
- "description": "Describing buckets with constant width.",
- "type": "object"
+ }
},
"AuthenticationInfo": {
"description": "Authentication information for the operation.",
"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"
- },
"principalEmail": {
"description": "The email address of the authenticated user making the request.",
"type": "string"
+ },
+ "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"
}
},
"id": "AuthenticationInfo"
},
"AllocateQuotaResponse": {
+ "description": "Response message for the AllocateQuota method.",
+ "type": "object",
"properties": {
"allocateErrors": {
"description": "Indicates the decision of the allocate.",
@@ -1230,17 +871,15 @@
}
},
"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."
},
"serviceConfigId": {
"description": "ID of the actual config used to process the request.",
"type": "string"
}
},
- "id": "AllocateQuotaResponse",
- "description": "Response message for the AllocateQuota method.",
- "type": "object"
+ "id": "AllocateQuotaResponse"
},
"ReleaseQuotaRequest": {
"description": "Request message for the ReleaseQuota method.",
@@ -1251,26 +890,26 @@
"type": "string"
},
"releaseOperation": {
- "description": "Operation that describes the quota release.",
- "$ref": "QuotaOperation"
+ "$ref": "QuotaOperation",
+ "description": "Operation that describes the quota release."
}
},
"id": "ReleaseQuotaRequest"
},
"RequestMetadata": {
+ "id": "RequestMetadata",
"description": "Metadata about the request.",
"type": "object",
"properties": {
+ "callerIp": {
+ "type": "string",
+ "description": "The IP address of the caller."
+ },
"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.",
"type": "string"
- },
- "callerIp": {
- "description": "The IP address of the caller.",
- "type": "string"
}
- },
- "id": "RequestMetadata"
+ }
},
"QuotaError": {
"properties": {
@@ -1283,6 +922,8 @@
"type": "string"
},
"code": {
+ "description": "Error code.",
+ "type": "string",
"enumDescriptions": [
"This is never used.",
"Quota allocation failed.\nSame as google.rpc.Code.RESOURCE_EXHAUSTED.",
@@ -1324,9 +965,7 @@
"SERVICE_STATUS_UNAVAILABLE",
"BILLING_STATUS_UNAVAILABLE",
"QUOTA_SYSTEM_UNAVAILABLE"
- ],
- "description": "Error code.",
- "type": "string"
+ ]
}
},
"id": "QuotaError",
@@ -1336,20 +975,113 @@
"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.",
"type": "array",
"items": {
"type": "string"
- }
+ },
+ "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."
}
},
"id": "CheckInfo"
+ },
+ "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": {
+ "type": "array",
+ "items": {
+ "$ref": "QuotaError"
+ },
+ "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\"",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValueSet"
+ }
+ },
+ "operationId": {
+ "type": "string",
+ "description": "The same operation_id value used in the ReleaseQuotaRequest. Used for\nlogging and diagnostics purposes."
+ }
+ },
+ "id": "ReleaseQuotaResponse"
+ },
+ "AllocateQuotaRequest": {
+ "description": "Request message for the AllocateQuota method.",
+ "type": "object",
+ "properties": {
+ "serviceConfigId": {
+ "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.",
+ "type": "string"
+ },
+ "allocateOperation": {
+ "description": "Operation that describes the quota allocation.",
+ "$ref": "QuotaOperation"
+ },
+ "allocationMode": {
+ "enumDescriptions": [
+ "",
+ "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, allocation error will be returned and no quota will be\nallocated.",
+ "Allocates quota for the amount specified in the service configuration or\nspecified using the quota_metrics. If the amount is higher than the\navailable quota, request does not fail but all available quota will be\nallocated.",
+ "Only checks if there is enough quota available and does not change the\navailable quota. No lock is placed on the available quota either."
+ ],
+ "enum": [
+ "UNSPECIFIED",
+ "NORMAL",
+ "BEST_EFFORT",
+ "CHECK_ONLY"
+ ],
+ "description": "Allocation mode for this operation.\nDeprecated: use QuotaMode inside the QuotaOperation.",
+ "type": "string"
+ }
+ },
+ "id": "AllocateQuotaRequest"
+ },
+ "MetricValueSet": {
+ "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.",
+ "type": "object",
+ "properties": {
+ "metricName": {
+ "description": "The metric name defined in the service configuration.",
+ "type": "string"
+ },
+ "metricValues": {
+ "description": "The values in this metric.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricValue"
+ }
+ }
+ },
+ "id": "MetricValueSet"
+ },
+ "ReportError": {
+ "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`."
+ }
+ },
+ "id": "ReportError",
+ "description": "Represents the processing error of one `Operation` in the request.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Service Control",
"auth": {
@@ -1369,5 +1101,273 @@
"name": "servicecontrol",
"batchPath": "batch",
"title": "Google Service Control API",
- "ownerName": "Google"
+ "ownerName": "Google",
+ "resources": {
+ "services": {
+ "methods": {
+ "startReconciliation": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "StartReconciliationResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:startReconciliation",
+ "id": "servicecontrol.services.startReconciliation",
+ "path": "v1/services/{serviceName}:startReconciliation",
+ "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": {
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:check",
+ "path": "v1/services/{serviceName}:check",
+ "id": "servicecontrol.services.check"
+ },
+ "releaseQuota": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "ReleaseQuotaResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}: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[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "ReleaseQuotaRequest"
+ }
+ },
+ "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"
+ },
+ "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.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:endReconciliation"
+ },
+ "report": {
+ "response": {
+ "$ref": "ReportResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "location": "path",
+ "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "flatPath": "v1/services/{serviceName}:report",
+ "path": "v1/services/{serviceName}:report",
+ "id": "servicecontrol.services.report",
+ "request": {
+ "$ref": "ReportRequest"
+ },
+ "description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the `ReportRequest` has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)."
+ },
+ "allocateQuota": {
+ "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[Google Cloud IAM](https://cloud.google.com/iam).",
+ "request": {
+ "$ref": "AllocateQuotaRequest"
+ },
+ "response": {
+ "$ref": "AllocateQuotaResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/servicecontrol"
+ ],
+ "parameters": {
+ "serviceName": {
+ "required": true,
+ "type": "string",
+ "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."
+ }
+ },
+ "flatPath": "v1/services/{serviceName}:allocateQuota"
+ }
+ }
+ }
+ },
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ }
+ },
+ "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": ""
}
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json
index d15cdb4..104f060 100644
--- a/servicemanagement/v1/servicemanagement-api.json
+++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,30 +1,62 @@
{
- "rootUrl": "https://servicemanagement.googleapis.com/",
- "basePath": "",
"ownerDomain": "google.com",
"name": "servicemanagement",
"batchPath": "batch",
- "revision": "20170227",
- "documentationLink": "https://cloud.google.com/service-management/",
"id": "servicemanagement:v1",
+ "documentationLink": "https://cloud.google.com/service-management/",
+ "revision": "20170306",
"title": "Google Service Management API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
"services": {
"methods": {
+ "create": {
+ "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
+ "request": {
+ "$ref": "ManagedService"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {},
+ "flatPath": "v1/services",
+ "path": "v1/services",
+ "id": "servicemanagement.services.create"
+ },
+ "generateConfigReport": {
+ "response": {
+ "$ref": "GenerateConfigReportResponse"
+ },
+ "parameterOrder": [],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {},
+ "flatPath": "v1/services:generateConfigReport",
+ "path": "v1/services:generateConfigReport",
+ "id": "servicemanagement.services.generateConfigReport",
+ "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
+ "request": {
+ "$ref": "GenerateConfigReportRequest"
+ }
+ },
"get": {
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.get",
- "description": "Gets a managed service. Authentication is required unless the service is\npublic.",
+ "httpMethod": "GET",
"response": {
"$ref": "ManagedService"
},
"parameterOrder": [
"serviceName"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only",
@@ -33,66 +65,60 @@
],
"parameters": {
"serviceName": {
+ "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.",
"required": true,
"type": "string",
- "location": "path",
- "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`."
+ "location": "path"
}
- }
+ },
+ "flatPath": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.get",
+ "path": "v1/services/{serviceName}",
+ "description": "Gets a managed service. Authentication is required unless the service is\npublic."
},
"testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
+ "httpMethod": "POST",
"parameterOrder": [
"resource"
],
- "httpMethod": "POST",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
"parameters": {
"resource": {
- "location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"required": true,
"type": "string",
- "pattern": "^services/[^/]+$"
+ "pattern": "^services/[^/]+$",
+ "location": "path"
}
},
"flatPath": "v1/services/{servicesId}:testIamPermissions",
- "path": "v1/{+resource}: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"
}
},
"getConfig": {
- "flatPath": "v1/services/{serviceName}/config",
- "path": "v1/services/{serviceName}/config",
- "id": "servicemanagement.services.getConfig",
- "description": "Gets a service configuration (version) for a managed service.",
- "parameterOrder": [
- "serviceName"
- ],
"httpMethod": "GET",
"response": {
"$ref": "Service"
},
- "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"
+ "parameterOrder": [
+ "serviceName"
],
"parameters": {
"serviceName": {
+ "location": "path",
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
"required": true,
- "type": "string",
- "location": "path"
+ "type": "string"
},
"configId": {
"location": "query",
@@ -100,24 +126,63 @@
"type": "string"
},
"view": {
- "location": "query",
"enum": [
"BASIC",
"FULL"
],
"description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
- }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/config",
+ "id": "servicemanagement.services.getConfig",
+ "path": "v1/services/{serviceName}/config",
+ "description": "Gets a service configuration (version) for a managed service."
},
- "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",
+ "httpMethod": "DELETE",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"serviceName"
],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}",
+ "id": "servicemanagement.services.delete",
+ "path": "v1/services/{serviceName}"
+ },
+ "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"
+ },
"httpMethod": "POST",
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
@@ -131,43 +196,10 @@
}
},
"flatPath": "v1/services/{serviceName}:enable",
- "path": "v1/services/{serviceName}:enable",
"id": "servicemanagement.services.enable",
- "description": "Enable a managed service for a project with default setting.\n\nOperation\u003cresponse: EnableServiceResponse\u003e\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail.",
- "request": {
- "$ref": "EnableServiceRequest"
- }
- },
- "delete": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "DELETE",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "flatPath": "v1/services/{serviceName}",
- "path": "v1/services/{serviceName}",
- "id": "servicemanagement.services.delete",
- "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e"
+ "path": "v1/services/{serviceName}:enable"
},
"setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
"response": {
"$ref": "Policy"
},
@@ -175,10 +207,6 @@
"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.",
@@ -188,12 +216,22 @@
"location": "path"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
"flatPath": "v1/services/{servicesId}:setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
- "id": "servicemanagement.services.setIamPolicy"
+ "id": "servicemanagement.services.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy."
},
"disable": {
- "description": "Disable a managed service for a project.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
+ "path": "v1/services/{serviceName}:disable",
+ "id": "servicemanagement.services.disable",
+ "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
"request": {
"$ref": "DisableServiceRequest"
},
@@ -216,51 +254,50 @@
"location": "path"
}
},
- "flatPath": "v1/services/{serviceName}:disable",
- "path": "v1/services/{serviceName}:disable",
- "id": "servicemanagement.services.disable"
+ "flatPath": "v1/services/{serviceName}:disable"
},
"getIamPolicy": {
- "flatPath": "v1/services/{servicesId}:getIamPolicy",
- "id": "servicemanagement.services.getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
+ "id": "servicemanagement.services.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"
},
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
"parameters": {
"resource": {
- "required": true,
- "type": "string",
"pattern": "^services/[^/]+$",
"location": "path",
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field."
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
- ]
+ ],
+ "flatPath": "v1/services/{servicesId}:getIamPolicy"
},
"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",
- "httpMethod": "POST",
- "parameterOrder": [
- "serviceName"
- ],
"response": {
"$ref": "Operation"
},
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
"parameters": {
"serviceName": {
"location": "path",
@@ -269,23 +306,21 @@
"type": "string"
}
},
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ]
+ "flatPath": "v1/services/{serviceName}:undelete",
+ "path": "v1/services/{serviceName}:undelete",
+ "id": "servicemanagement.services.undelete"
},
"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"
},
+ "parameterOrder": [],
+ "httpMethod": "GET",
"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",
- "location": "query"
+ "type": "string"
},
"pageToken": {
"description": "Token identifying which result to start with; returned by a previous list\ncall.",
@@ -293,10 +328,10 @@
"location": "query"
},
"pageSize": {
- "location": "query",
"description": "Requested size of the next page of data.",
"format": "int32",
- "type": "integer"
+ "type": "integer",
+ "location": "query"
},
"producerProjectId": {
"description": "Include services produced by the specified project.",
@@ -311,265 +346,17 @@
"https://www.googleapis.com/auth/service.management.readonly"
],
"flatPath": "v1/services",
+ "path": "v1/services",
"id": "servicemanagement.services.list",
- "path": "v1/services"
- },
- "create": {
- "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e",
- "request": {
- "$ref": "ManagedService"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {},
- "flatPath": "v1/services",
- "id": "servicemanagement.services.create",
- "path": "v1/services"
- },
- "generateConfigReport": {
- "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.",
- "request": {
- "$ref": "GenerateConfigReportRequest"
- },
- "response": {
- "$ref": "GenerateConfigReportResponse"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {},
- "flatPath": "v1/services:generateConfigReport",
- "path": "v1/services:generateConfigReport",
- "id": "servicemanagement.services.generateConfigReport"
+ "description": "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}\"."
}
},
"resources": {
- "configs": {
- "methods": {
- "submit": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs:submit",
- "path": "v1/services/{serviceName}/configs:submit",
- "id": "servicemanagement.services.configs.submit",
- "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
- "request": {
- "$ref": "SubmitConfigSourceRequest"
- }
- },
- "list": {
- "response": {
- "$ref": "ListServiceConfigsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The token of the page to retrieve."
- },
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs",
- "path": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.list",
- "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest."
- },
- "get": {
- "description": "Gets a service configuration (version) for a managed service.",
- "httpMethod": "GET",
- "response": {
- "$ref": "Service"
- },
- "parameterOrder": [
- "serviceName",
- "configId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "parameters": {
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "configId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The id of the service configuration resource."
- },
- "view": {
- "location": "query",
- "enum": [
- "BASIC",
- "FULL"
- ],
- "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
- "type": "string"
- }
- },
- "flatPath": "v1/services/{serviceName}/configs/{configId}",
- "id": "servicemanagement.services.configs.get",
- "path": "v1/services/{serviceName}/configs/{configId}"
- },
- "create": {
- "request": {
- "$ref": "Service"
- },
- "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
- "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`.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/service.management"
- ],
- "flatPath": "v1/services/{serviceName}/configs",
- "id": "servicemanagement.services.configs.create",
- "path": "v1/services/{serviceName}/configs"
- }
- }
- },
"rollouts": {
"methods": {
- "list": {
- "path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.list",
- "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.",
- "response": {
- "$ref": "ListServiceRolloutsResponse"
- },
- "parameterOrder": [
- "serviceName"
- ],
- "httpMethod": "GET",
- "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": {
- "pageSize": {
- "description": "The max number of items to include in the response list.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "serviceName": {
- "location": "path",
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "type": "string",
- "location": "query",
- "description": "The token of the page to retrieve."
- }
- },
- "flatPath": "v1/services/{serviceName}/rollouts"
- },
- "get": {
- "description": "Gets a service configuration rollout.",
- "httpMethod": "GET",
- "parameterOrder": [
- "serviceName",
- "rolloutId"
- ],
- "response": {
- "$ref": "Rollout"
- },
- "parameters": {
- "serviceName": {
- "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "rolloutId": {
- "description": "The id of the rollout resource.",
- "required": true,
- "type": "string",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/cloud-platform.read-only",
- "https://www.googleapis.com/auth/service.management",
- "https://www.googleapis.com/auth/service.management.readonly"
- ],
- "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
- "id": "servicemanagement.services.rollouts.get",
- "path": "v1/services/{serviceName}/rollouts/{rolloutId}"
- },
"create": {
+ "path": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.create",
"request": {
"$ref": "Rollout"
},
@@ -593,9 +380,220 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
+ "flatPath": "v1/services/{serviceName}/rollouts"
+ },
+ "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": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to retrieve.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
"flatPath": "v1/services/{serviceName}/rollouts",
+ "id": "servicemanagement.services.rollouts.list",
"path": "v1/services/{serviceName}/rollouts",
- "id": "servicemanagement.services.rollouts.create"
+ "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest."
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "serviceName",
+ "rolloutId"
+ ],
+ "response": {
+ "$ref": "Rollout"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "rolloutId": {
+ "description": "The id of the rollout resource.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "id": "servicemanagement.services.rollouts.get",
+ "path": "v1/services/{serviceName}/rollouts/{rolloutId}",
+ "description": "Gets a service configuration rollout."
+ }
+ }
+ },
+ "configs": {
+ "methods": {
+ "submit": {
+ "path": "v1/services/{serviceName}/configs:submit",
+ "id": "servicemanagement.services.configs.submit",
+ "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e",
+ "request": {
+ "$ref": "SubmitConfigSourceRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs:submit"
+ },
+ "list": {
+ "path": "v1/services/{serviceName}/configs",
+ "id": "servicemanagement.services.configs.list",
+ "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.",
+ "response": {
+ "$ref": "ListServiceConfigsResponse"
+ },
+ "parameterOrder": [
+ "serviceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "The token of the page to retrieve.",
+ "type": "string"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The max number of items to include in the response list.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs"
+ },
+ "get": {
+ "response": {
+ "$ref": "Service"
+ },
+ "parameterOrder": [
+ "serviceName",
+ "configId"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only",
+ "https://www.googleapis.com/auth/service.management",
+ "https://www.googleapis.com/auth/service.management.readonly"
+ ],
+ "parameters": {
+ "serviceName": {
+ "location": "path",
+ "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.",
+ "required": true,
+ "type": "string"
+ },
+ "configId": {
+ "location": "path",
+ "description": "The id of the service configuration resource.",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "enum": [
+ "BASIC",
+ "FULL"
+ ],
+ "description": "Specifies which parts of the Service Config should be returned in the\nresponse.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "flatPath": "v1/services/{serviceName}/configs/{configId}",
+ "path": "v1/services/{serviceName}/configs/{configId}",
+ "id": "servicemanagement.services.configs.get",
+ "description": "Gets a service configuration (version) for a managed service."
+ },
+ "create": {
+ "id": "servicemanagement.services.configs.create",
+ "path": "v1/services/{serviceName}/configs",
+ "request": {
+ "$ref": "Service"
+ },
+ "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.",
+ "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`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/services/{serviceName}/configs"
}
}
}
@@ -603,6 +601,48 @@
},
"operations": {
"methods": {
+ "list": {
+ "path": "v1/{+name}",
+ "id": "servicemanagement.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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^operations$",
+ "location": "path",
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "The standard list page token.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/service.management"
+ ],
+ "flatPath": "v1/operations"
+ },
"get": {
"response": {
"$ref": "Operation"
@@ -611,19 +651,19 @@
"name"
],
"httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "pattern": "^operations/.+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/service.management"
],
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^operations/.+$"
- }
- },
"flatPath": "v1/operations/{operationsId}",
"path": "v1/{+name}",
"id": "servicemanagement.operations.get",
@@ -633,15 +673,36 @@
}
},
"parameters": {
- "oauth_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 2.0 token for the current user.",
+ "description": "OAuth access token.",
"type": "string"
},
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
"bearer_token": {
- "location": "query",
"description": "OAuth bearer token.",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"upload_protocol": {
"location": "query",
@@ -649,10 +710,10 @@
"type": "string"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
@@ -665,22 +726,22 @@
"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"
+ "type": "string",
+ "location": "query"
},
"alt": {
"enum": [
@@ -697,1032 +758,11 @@
"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.",
- "type": "boolean",
- "default": "true"
}
},
"schemas": {
- "GenerateConfigReportRequest": {
- "id": "GenerateConfigReportRequest",
- "description": "Request message for GenerateConfigReport method.",
- "type": "object",
- "properties": {
- "oldConfig": {
- "type": "object",
- "additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
- },
- "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": {
- "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"
- }
- }
- },
- "SetIamPolicyRequest": {
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- },
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- }
- }
- },
- "Step": {
- "description": "Represents the status of one operation step.",
- "type": "object",
- "properties": {
- "description": {
- "description": "The short description of the step.",
- "type": "string"
- },
- "status": {
- "description": "The status code.",
- "type": "string",
- "enumDescriptions": [
- "Unspecifed code.",
- "The operation or step has completed without errors.",
- "The operation or step has not started yet.",
- "The operation or step is in progress.",
- "The operation or step has completed with errors.",
- "The operation or step has completed with cancellation."
- ],
- "enum": [
- "STATUS_UNSPECIFIED",
- "DONE",
- "NOT_STARTED",
- "IN_PROGRESS",
- "FAILED",
- "CANCELLED"
- ]
- }
- },
- "id": "Step"
- },
- "DeleteServiceStrategy": {
- "id": "DeleteServiceStrategy",
- "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
- "type": "object",
- "properties": {}
- },
- "LoggingDestination": {
- "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
- "type": "object",
- "properties": {
- "logs": {
- "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "monitoredResource": {
- "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
- "type": "string"
- }
- },
- "id": "LoggingDestination"
- },
- "Option": {
- "id": "Option",
- "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`."
- },
- "value": {
- "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"
- }
- }
- }
- },
- "Logging": {
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- },
- "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination."
- },
- "producerDestinations": {
- "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "LoggingDestination"
- }
- }
- },
- "id": "Logging",
- "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history"
- },
- "Method": {
- "description": "Method represents a method of an api.",
- "type": "object",
- "properties": {
- "responseTypeUrl": {
- "description": "The URL of the output message type.",
- "type": "string"
- },
- "options": {
- "description": "Any metadata attached to the method.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "responseStreaming": {
- "description": "If true, the response is streamed.",
- "type": "boolean"
- },
- "name": {
- "description": "The simple name of this method.",
- "type": "string"
- },
- "requestTypeUrl": {
- "description": "A URL of the input message type.",
- "type": "string"
- },
- "requestStreaming": {
- "description": "If true, the request is streamed.",
- "type": "boolean"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax of this method.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- }
- },
- "id": "Method"
- },
- "ListServiceRolloutsResponse": {
- "description": "Response message for ListServiceRollouts method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
- },
- "rollouts": {
- "type": "array",
- "items": {
- "$ref": "Rollout"
- },
- "description": "The list of rollout resources."
- }
- },
- "id": "ListServiceRolloutsResponse"
- },
- "ConfigRef": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
- "type": "string"
- }
- },
- "id": "ConfigRef",
- "description": "Represents a service configuration with its name and id."
- },
- "Mixin": {
- "id": "Mixin",
- "description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand 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 API plus the root path if specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
- "type": "object",
- "properties": {
- "root": {
- "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
- "type": "string"
- },
- "name": {
- "description": "The fully qualified name of the API which is included.",
- "type": "string"
- }
- }
- },
- "CustomError": {
- "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
- "type": "object",
- "properties": {
- "rules": {
- "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "CustomErrorRule"
- }
- },
- "types": {
- "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "CustomError"
- },
- "CounterOptions": {
- "description": "Options for counters",
- "type": "object",
- "properties": {
- "metric": {
- "description": "The metric to update.",
- "type": "string"
- },
- "field": {
- "description": "The field value to attribute.",
- "type": "string"
- }
- },
- "id": "CounterOptions"
- },
- "Http": {
- "description": "Defines the HTTP configuration for a service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "HttpRule"
- }
- }
- },
- "id": "Http"
- },
- "Control": {
- "id": "Control",
- "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
- "type": "object",
- "properties": {
- "environment": {
- "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
- "type": "string"
- }
- }
- },
- "SystemParameter": {
- "id": "SystemParameter",
- "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
- "type": "object",
- "properties": {
- "httpHeader": {
- "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
- "type": "string"
- },
- "name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
- },
- "urlQueryParameter": {
- "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.",
- "type": "string"
- }
- }
- },
- "Field": {
- "description": "A single field of a message type.",
- "type": "object",
- "properties": {
- "typeUrl": {
- "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
- "type": "string"
- },
- "number": {
- "description": "The field number.",
- "format": "int32",
- "type": "integer"
- },
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
- "kind": {
- "description": "The field type.",
- "type": "string",
- "enumDescriptions": [
- "Field type unknown.",
- "Field type double.",
- "Field type float.",
- "Field type int64.",
- "Field type uint64.",
- "Field type int32.",
- "Field type fixed64.",
- "Field type fixed32.",
- "Field type bool.",
- "Field type string.",
- "Field type group. Proto2 syntax only, and deprecated.",
- "Field type message.",
- "Field type bytes.",
- "Field type uint32.",
- "Field type enum.",
- "Field type sfixed32.",
- "Field type sfixed64.",
- "Field type sint32.",
- "Field type sint64."
- ],
- "enum": [
- "TYPE_UNKNOWN",
- "TYPE_DOUBLE",
- "TYPE_FLOAT",
- "TYPE_INT64",
- "TYPE_UINT64",
- "TYPE_INT32",
- "TYPE_FIXED64",
- "TYPE_FIXED32",
- "TYPE_BOOL",
- "TYPE_STRING",
- "TYPE_GROUP",
- "TYPE_MESSAGE",
- "TYPE_BYTES",
- "TYPE_UINT32",
- "TYPE_ENUM",
- "TYPE_SFIXED32",
- "TYPE_SFIXED64",
- "TYPE_SINT32",
- "TYPE_SINT64"
- ]
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "oneofIndex": {
- "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "id": "Field"
- },
- "Monitoring": {
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- },
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- }
- },
- "id": "Monitoring"
- },
- "TestIamPermissionsRequest": {
- "type": "object",
- "properties": {
- "permissions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)."
- }
- },
- "id": "TestIamPermissionsRequest",
- "description": "Request message for `TestIamPermissions` method."
- },
- "Enum": {
- "description": "Enum type definition.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Enum type name.",
- "type": "string"
- },
- "enumvalue": {
- "description": "Enum value definitions.",
- "type": "array",
- "items": {
- "$ref": "EnumValue"
- }
- },
- "options": {
- "description": "Protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
- }
- },
- "id": "Enum"
- },
- "LabelDescriptor": {
- "properties": {
- "key": {
- "description": "The label key.",
- "type": "string"
- },
- "description": {
- "description": "A human-readable description for the label.",
- "type": "string"
- },
- "valueType": {
- "enumDescriptions": [
- "A variable-length string. This is the default.",
- "Boolean; true or false.",
- "A 64-bit signed integer."
- ],
- "enum": [
- "STRING",
- "BOOL",
- "INT64"
- ],
- "description": "The type of data that can be assigned to the label.",
- "type": "string"
- }
- },
- "id": "LabelDescriptor",
- "description": "A description of a label.",
- "type": "object"
- },
- "Diagnostic": {
- "description": "Represents a diagnostic message (error or warning)",
- "type": "object",
- "properties": {
- "kind": {
- "enumDescriptions": [
- "Warnings and errors",
- "Only errors"
- ],
- "enum": [
- "WARNING",
- "ERROR"
- ],
- "description": "The kind of diagnostic information provided.",
- "type": "string"
- },
- "message": {
- "description": "Message describing the error or warning.",
- "type": "string"
- },
- "location": {
- "description": "File name and line number of the error or warning.",
- "type": "string"
- }
- },
- "id": "Diagnostic"
- },
- "EnableServiceRequest": {
- "description": "Request message for EnableService method.",
- "type": "object",
- "properties": {
- "consumerId": {
- "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
- "type": "string"
- }
- },
- "id": "EnableServiceRequest"
- },
- "Type": {
- "description": "A protocol buffer message type.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The list of fields.",
- "type": "array",
- "items": {
- "$ref": "Field"
- }
- },
- "name": {
- "description": "The fully qualified message name.",
- "type": "string"
- },
- "oneofs": {
- "description": "The list of types appearing in `oneof` definitions in this type.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "syntax": {
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ],
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
- },
- "sourceContext": {
- "$ref": "SourceContext",
- "description": "The source context."
- },
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- }
- },
- "id": "Type"
- },
- "GenerateConfigReportResponse": {
- "description": "Response message for GenerateConfigReport method.",
- "type": "object",
- "properties": {
- "id": {
- "type": "string",
- "description": "ID of the service configuration this report belongs to."
- },
- "diagnostics": {
- "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
- "type": "array",
- "items": {
- "$ref": "Diagnostic"
- }
- },
- "serviceName": {
- "description": "Name of the service this report belongs to.",
- "type": "string"
- },
- "changeReports": {
- "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
- "type": "array",
- "items": {
- "$ref": "ChangeReport"
- }
- }
- },
- "id": "GenerateConfigReportResponse"
- },
- "Experimental": {
- "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.",
- "type": "object",
- "properties": {
- "authorization": {
- "$ref": "AuthorizationConfig",
- "description": "Authorization configuration."
- }
- },
- "id": "Experimental"
- },
- "ListServiceConfigsResponse": {
- "description": "Response message for ListServiceConfigs method.",
- "type": "object",
- "properties": {
- "nextPageToken": {
- "description": "The token of the next page of results.",
- "type": "string"
- },
- "serviceConfigs": {
- "description": "The list of service configuration resources.",
- "type": "array",
- "items": {
- "$ref": "Service"
- }
- }
- },
- "id": "ListServiceConfigsResponse"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\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, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditConfig"
- },
- "Backend": {
- "description": "`Backend` defines the backend configuration for a service.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "BackendRule"
- }
- }
- },
- "id": "Backend"
- },
- "SubmitConfigSourceRequest": {
- "description": "Request message for SubmitConfigSource method.",
- "type": "object",
- "properties": {
- "configSource": {
- "description": "The source configuration for the service.",
- "$ref": "ConfigSource"
- },
- "validateOnly": {
- "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
- "type": "boolean"
- }
- },
- "id": "SubmitConfigSourceRequest"
- },
- "AuthorizationConfig": {
- "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": {
- "properties": {
- "selector": {
- "type": "string",
- "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."
- },
- "description": {
- "type": "string",
- "description": "Description of the selected API(s)."
- },
- "deprecationDescription": {
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
- "type": "string"
- }
- },
- "id": "DocumentationRule",
- "description": "A documentation rule provides information about individual API elements.",
- "type": "object"
- },
- "CloudAuditOptions": {
- "type": "object",
- "properties": {},
- "id": "CloudAuditOptions",
- "description": "Write a Cloud Audit log"
- },
- "ContextRule": {
- "description": "A context rule provides information about the context for an individual API\nelement.",
- "type": "object",
- "properties": {
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "provided": {
- "description": "A list of full type names of provided contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "ContextRule"
- },
- "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": {
- "type": "string",
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\"."
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The resource name of the metric descriptor. 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": {
- "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": {
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ],
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported."
- }
- },
- "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"
- },
- "ListServicesResponse": {
- "type": "object",
- "properties": {
- "services": {
- "description": "The returned services will only have the name field set.",
- "type": "array",
- "items": {
- "$ref": "ManagedService"
- }
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListServices` to resume a paginated query.",
- "type": "string"
- }
- },
- "id": "ListServicesResponse",
- "description": "Response message for `ListServices` method."
- },
- "Endpoint": {
- "id": "Endpoint",
- "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
- "type": "object",
- "properties": {
- "aliases": {
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "features": {
- "description": "The list of features enabled on this endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "allowCors": {
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
- "type": "boolean"
- },
- "name": {
- "description": "The canonical name of this endpoint.",
- "type": "string"
- },
- "apis": {
- "description": "The list of APIs served by this endpoint.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "OAuthRequirements": {
- "id": "OAuthRequirements",
- "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
- "type": "object",
- "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"
- }
- }
- },
- "GetIamPolicyRequest": {
- "id": "GetIamPolicyRequest",
- "description": "Request message for `GetIamPolicy` method.",
- "type": "object",
- "properties": {}
- },
- "TestIamPermissionsResponse": {
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
- },
- "Usage": {
- "description": "Configuration controlling usage of a service.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "UsageRule"
- }
- },
- "requirements": {
- "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "producerNotificationChannel": {
- "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
- "type": "string"
- }
- },
- "id": "Usage"
- },
- "Context": {
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "ContextRule"
- }
- }
- },
- "id": "Context"
- },
"Rule": {
- "description": "A rule to be applied in a Policy.",
- "type": "object",
"properties": {
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "type": "string",
- "description": "Human-readable description of the rule."
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "type": "array",
- "items": {
- "$ref": "Condition"
- }
- },
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"type": "array",
@@ -1745,14 +785,6 @@
}
},
"action": {
- "enumDescriptions": [
- "Default no action.",
- "Matching 'Entries' grant access.",
- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' deny access.",
- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' tell IAM.Check callers to generate logs."
- ],
"enum": [
"NO_ACTION",
"ALLOW",
@@ -1762,20 +794,48 @@
"LOG"
],
"description": "Required",
+ "type": "string",
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ]
+ },
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
"type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
+ }
}
},
- "id": "Rule"
+ "id": "Rule",
+ "description": "A rule to be applied in a Policy.",
+ "type": "object"
},
"LogConfig": {
"properties": {
"cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "CloudAuditOptions"
+ "$ref": "CloudAuditOptions",
+ "description": "Cloud audit options."
},
"counter": {
- "$ref": "CounterOptions",
- "description": "Counter options."
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
},
"dataAccess": {
"description": "Data access options.",
@@ -1787,15 +847,9 @@
"type": "object"
},
"LogDescriptor": {
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
"type": "object",
"properties": {
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
"name": {
"description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
"type": "string"
@@ -1807,16 +861,26 @@
"displayName": {
"description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
"type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
}
},
- "id": "LogDescriptor",
- "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"
+ "id": "LogDescriptor"
},
"ConfigFile": {
+ "description": "Generic specification of a source configuration file",
"type": "object",
"properties": {
+ "filePath": {
+ "description": "The file name of the configuration file (full or relative path).",
+ "type": "string"
+ },
"fileType": {
- "type": "string",
"enumDescriptions": [
"Unknown file type.",
"YAML-specification of service.",
@@ -1831,48 +895,21 @@
"OPEN_API_YAML",
"FILE_DESCRIPTOR_SET_PROTO"
],
- "description": "The type of configuration file this represents."
+ "description": "The type of configuration file this represents.",
+ "type": "string"
},
"fileContents": {
"description": "The bytes that constitute the file.",
"format": "byte",
"type": "string"
- },
- "filePath": {
- "description": "The file name of the configuration file (full or relative path).",
- "type": "string"
}
},
- "id": "ConfigFile",
- "description": "Generic specification of a source configuration file"
- },
- "CustomErrorRule": {
- "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",
- "description": "A custom error rule."
+ "id": "ConfigFile"
},
"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": {
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- },
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`."
- },
"name": {
"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"
@@ -1888,12 +925,33 @@
"type": {
"description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
"type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
}
- }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "CustomErrorRule": {
+ "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"
},
"MediaDownload": {
- "description": "Use 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.",
@@ -1904,21 +962,23 @@
"type": "string"
}
},
- "id": "MediaDownload"
+ "id": "MediaDownload",
+ "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.",
+ "type": "object"
},
"ChangeReport": {
- "id": "ChangeReport",
- "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
- "type": "object",
"properties": {
"configChanges": {
+ "description": "List of changes between two service configurations.\nThe changes will be alphabetically sorted based on the identifier\nof each change.\nA ConfigChange identifier is a dot separated path to the configuration.\nExample: visibility.rules[selector='LibraryService.CreateBook'].restriction",
"type": "array",
"items": {
"$ref": "ConfigChange"
- },
- "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"
+ }
}
- }
+ },
+ "id": "ChangeReport",
+ "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.",
+ "type": "object"
},
"DisableServiceRequest": {
"description": "Request message for DisableService method.",
@@ -1932,56 +992,56 @@
"id": "DisableServiceRequest"
},
"SubmitConfigSourceResponse": {
+ "description": "Response message for SubmitConfigSource method.",
+ "type": "object",
"properties": {
"serviceConfig": {
"$ref": "Service",
"description": "The generated service configuration."
}
},
- "id": "SubmitConfigSourceResponse",
- "description": "Response message for SubmitConfigSource method.",
- "type": "object"
+ "id": "SubmitConfigSourceResponse"
},
"MediaUpload": {
- "description": "Use 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": {
- "uploadService": {
- "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
- "type": "string"
- },
"enabled": {
"description": "Whether upload is enabled.",
"type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
}
},
- "id": "MediaUpload"
+ "id": "MediaUpload",
+ "description": "Use 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"
},
"Advice": {
- "id": "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": {
- "type": "string",
- "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks."
+ "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"
},
"ManagedService": {
- "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
- "type": "object",
"properties": {
- "producerProjectId": {
- "description": "ID of the project that produces and owns this service.",
- "type": "string"
- },
"serviceName": {
"description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements.",
"type": "string"
+ },
+ "producerProjectId": {
+ "description": "ID of the project that produces and owns this service.",
+ "type": "string"
}
},
- "id": "ManagedService"
+ "id": "ManagedService",
+ "description": "The full representation of a Service that is managed by\nGoogle Service Management.",
+ "type": "object"
},
"UsageRule": {
"description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
@@ -2029,14 +1089,7 @@
"id": "TrafficPercentStrategy"
},
"Documentation": {
- "id": "Documentation",
- "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
- "type": "object",
"properties": {
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- },
"documentationRootUrl": {
"description": "The URL to the root of documentation.",
"type": "string"
@@ -2049,8 +1102,8 @@
}
},
"overview": {
- "type": "string",
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field."
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
},
"pages": {
"description": "The top level pages for the documentation set.",
@@ -2058,13 +1111,40 @@
"items": {
"$ref": "Page"
}
+ },
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
}
- }
+ },
+ "id": "Documentation",
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
+ "type": "object"
},
"Condition": {
- "description": "A condition to be met.",
- "type": "object",
"properties": {
+ "sys": {
+ "enumDescriptions": [
+ "Default non-attribute type",
+ "Region of the resource",
+ "Service name",
+ "Resource name",
+ "IP address of the caller"
+ ],
+ "enum": [
+ "NO_ATTR",
+ "REGION",
+ "SERVICE",
+ "NAME",
+ "IP"
+ ],
+ "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
+ "type": "string"
+ },
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ },
"values": {
"description": "The objects of the condition. This is mutually exclusive with 'value'.",
"type": "array",
@@ -2073,14 +1153,6 @@
}
},
"iam": {
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
- "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
- ],
"enum": [
"NO_ATTR",
"AUTHORITY",
@@ -2088,9 +1160,25 @@
"APPROVER",
"JUSTIFICATION_TYPE"
],
- "description": "Trusted attributes supplied by the IAM system."
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
+ "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
+ ]
},
"op": {
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
+ "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
+ "Subject is discharged"
+ ],
"enum": [
"NO_OP",
"EQUALS",
@@ -2100,52 +1188,29 @@
"DISCHARGED"
],
"description": "An operator to apply the subject with.",
- "type": "string",
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
- "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
- "Subject is discharged"
- ]
+ "type": "string"
},
"svc": {
"description": "Trusted attributes discharged by the service.",
"type": "string"
- },
- "sys": {
- "enum": [
- "NO_ATTR",
- "REGION",
- "SERVICE",
- "NAME",
- "IP"
- ],
- "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute type",
- "Region of the resource",
- "Service name",
- "Resource name",
- "IP address of the caller"
- ]
- },
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
- "type": "string"
}
},
- "id": "Condition"
+ "id": "Condition",
+ "description": "A condition to be met.",
+ "type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
"type": "object",
"properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"logType": {
- "description": "The log type that this config enables.",
- "type": "string",
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
@@ -2157,21 +1222,14 @@
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
- ]
- },
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
+ ],
+ "description": "The log type that this config enables.",
+ "type": "string"
}
},
"id": "AuditLogConfig"
},
"ConfigSource": {
- "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
- "type": "object",
"properties": {
"files": {
"description": "Set of source configuration files that are used to generate a service\nconfiguration (`google.api.Service`).",
@@ -2185,7 +1243,35 @@
"type": "string"
}
},
- "id": "ConfigSource"
+ "id": "ConfigSource",
+ "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.",
+ "type": "object"
+ },
+ "AuthenticationRule": {
+ "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.",
+ "type": "object",
+ "properties": {
+ "oauth": {
+ "$ref": "OAuthRequirements",
+ "description": "The requirements for OAuth credentials."
+ },
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthRequirement"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ }
+ },
+ "id": "AuthenticationRule"
},
"BackendRule": {
"description": "A backend rule provides configuration for an individual API element.",
@@ -2207,66 +1293,10 @@
},
"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": {
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "oauth": {
- "description": "The requirements for OAuth credentials.",
- "$ref": "OAuthRequirements"
- },
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- }
- },
- "id": "AuthenticationRule"
- },
- "UndeleteServiceResponse": {
- "description": "Response message for UndeleteService method.",
- "type": "object",
- "properties": {
- "service": {
- "$ref": "ManagedService",
- "description": "Revived service resource."
- }
- },
- "id": "UndeleteServiceResponse"
- },
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
"type": "object",
"properties": {
- "version": {
- "type": "integer",
- "description": "Version of the `Policy`. The default version is 0.",
- "format": "int32"
- },
- "auditConfigs": {
- "description": "Specifies cloud audit logging configuration for this policy.",
- "type": "array",
- "items": {
- "$ref": "AuditConfig"
- }
- },
- "bindings": {
- "type": "array",
- "items": {
- "$ref": "Binding"
- },
- "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error."
- },
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"format": "byte",
@@ -2281,10 +1311,40 @@
"items": {
"$ref": "Rule"
}
+ },
+ "version": {
+ "description": "Version of the `Policy`. The default version is 0.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "auditConfigs": {
+ "description": "Specifies cloud audit logging configuration for this policy.",
+ "type": "array",
+ "items": {
+ "$ref": "AuditConfig"
+ }
+ },
+ "bindings": {
+ "description": "Associates a list of `members` to a `role`.\nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with no members will result in an error.",
+ "type": "array",
+ "items": {
+ "$ref": "Binding"
+ }
}
},
"id": "Policy"
},
+ "UndeleteServiceResponse": {
+ "properties": {
+ "service": {
+ "description": "Revived service resource.",
+ "$ref": "ManagedService"
+ }
+ },
+ "id": "UndeleteServiceResponse",
+ "description": "Response message for UndeleteService method.",
+ "type": "object"
+ },
"Api": {
"properties": {
"options": {
@@ -2302,8 +1362,8 @@
}
},
"name": {
- "type": "string",
- "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name."
+ "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
+ "type": "string"
},
"syntax": {
"enumDescriptions": [
@@ -2318,19 +1378,19 @@
"type": "string"
},
"sourceContext": {
- "description": "Source context for the protocol buffer service represented by this\nmessage.",
- "$ref": "SourceContext"
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
},
"version": {
- "type": "string",
- "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided 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\nAPI, 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, none-GA apis.\n"
+ "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided 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\nAPI, 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, none-GA apis.\n",
+ "type": "string"
},
"mixins": {
+ "description": "Included APIs. See Mixin.",
"type": "array",
"items": {
"$ref": "Mixin"
- },
- "description": "Included APIs. See Mixin."
+ }
}
},
"id": "Api",
@@ -2344,7 +1404,6 @@
"id": "DataAccessOptions"
},
"Authentication": {
- "type": "object",
"properties": {
"rules": {
"description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -2362,23 +1421,20 @@
}
},
"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"
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"type": "object",
"properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
"response": {
- "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`.",
@@ -2389,18 +1445,21 @@
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
- "type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any."
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
"id": "Operation"
},
"Page": {
- "id": "Page",
"description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
"type": "object",
"properties": {
@@ -2409,8 +1468,8 @@
"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."
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
},
"subpages": {
"description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
@@ -2419,57 +1478,62 @@
"$ref": "Page"
}
}
- }
+ },
+ "id": "Page"
},
"Status": {
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
- "type": "object",
"properties": {
- "code": {
- "type": "integer",
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
"message": {
- "type": "string",
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client."
+ "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 will be a\ncommon set of message types for APIs to use.",
"type": "array",
"items": {
"additionalProperties": {
- "type": "any",
- "description": "Properties of the object. Contains field @type with type URL."
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
},
"type": "object"
}
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Status"
+ "id": "Status",
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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": {
- "id": "Binding",
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- },
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"type": "array",
"items": {
"type": "string"
}
+ },
+ "role": {
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
+ "type": "string"
}
- }
+ },
+ "id": "Binding"
},
"AuthProvider": {
"description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
"type": "object",
"properties": {
+ "jwksUri": {
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
+ "type": "string"
+ },
"audiences": {
"description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
"type": "string"
@@ -2481,48 +1545,46 @@
"issuer": {
"description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
"type": "string"
- },
- "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": {
+ "number": {
+ "description": "Enum value number.",
+ "format": "int32",
+ "type": "integer"
+ },
"name": {
"description": "Enum value name.",
"type": "string"
},
"options": {
+ "description": "Protocol buffer options.",
"type": "array",
"items": {
"$ref": "Option"
- },
- "description": "Protocol buffer options."
- },
- "number": {
- "description": "Enum value number.",
- "format": "int32",
- "type": "integer"
+ }
}
},
- "id": "EnumValue"
+ "id": "EnumValue",
+ "description": "Enum value definition.",
+ "type": "object"
},
"Service": {
- "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object",
"properties": {
+ "authentication": {
+ "$ref": "Authentication",
+ "description": "Auth configuration."
+ },
"experimental": {
"$ref": "Experimental",
"description": "Experimental configuration."
},
"control": {
- "description": "Configuration for the service control plane.",
- "$ref": "Control"
+ "$ref": "Control",
+ "description": "Configuration for the service control plane."
},
"configVersion": {
"description": "The version of the service configuration. The config version may\ninfluence interpretation of the configuration, for example, to\ndetermine defaults. This is documented together with applicable\noptions. The current default for the config version itself is `3`.",
@@ -2530,8 +1592,12 @@
"type": "integer"
},
"monitoring": {
- "description": "Monitoring configuration.",
- "$ref": "Monitoring"
+ "$ref": "Monitoring",
+ "description": "Monitoring configuration."
+ },
+ "producerProjectId": {
+ "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
+ "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.",
@@ -2540,10 +1606,6 @@
"$ref": "Type"
}
},
- "producerProjectId": {
- "description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
- "type": "string"
- },
"visibility": {
"$ref": "Visibility",
"description": "API visibility configuration."
@@ -2553,12 +1615,12 @@
"type": "string"
},
"customError": {
- "description": "Custom error configuration.",
- "$ref": "CustomError"
+ "$ref": "CustomError",
+ "description": "Custom error configuration."
},
"title": {
- "type": "string",
- "description": "The product title associated with this service."
+ "description": "The product title associated with 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.",
@@ -2588,21 +1650,25 @@
"$ref": "Type"
}
},
+ "sourceInfo": {
+ "$ref": "SourceInfo",
+ "description": "Output only. The source information for this configuration if available."
+ },
"http": {
"description": "HTTP configuration.",
"$ref": "Http"
},
"backend": {
- "description": "API backend configuration.",
- "$ref": "Backend"
+ "$ref": "Backend",
+ "description": "API backend configuration."
},
"systemParameters": {
"description": "System parameter configuration.",
"$ref": "SystemParameters"
},
"documentation": {
- "$ref": "Documentation",
- "description": "Additional API 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.",
@@ -2612,27 +1678,27 @@
}
},
"logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
+ "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",
+ "type": "array",
+ "items": {
+ "$ref": "Enum"
+ }
},
"context": {
"$ref": "Context",
"description": "Context configuration."
},
- "enums": {
- "type": "array",
- "items": {
- "$ref": "Enum"
- },
- "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum"
- },
"id": {
"description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
"type": "string"
},
"usage": {
- "$ref": "Usage",
- "description": "Configuration controlling usage of this service."
+ "description": "Configuration controlling usage of this service.",
+ "$ref": "Usage"
},
"metrics": {
"description": "Defines the metrics used by this service.",
@@ -2640,28 +1706,29 @@
"items": {
"$ref": "MetricDescriptor"
}
- },
- "authentication": {
- "$ref": "Authentication",
- "description": "Auth configuration."
}
},
- "id": "Service"
+ "id": "Service",
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object"
},
- "CustomHttpPattern": {
- "description": "A custom pattern is used for defining custom HTTP verb.",
+ "ListOperationsResponse": {
+ "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
- "path": {
- "description": "The path matched by this custom verb.",
+ "nextPageToken": {
+ "description": "The standard List next-page token.",
"type": "string"
},
- "kind": {
- "description": "The name of this custom HTTP verb.",
- "type": "string"
+ "operations": {
+ "description": "A list of operations that matches the specified filter in the request.",
+ "type": "array",
+ "items": {
+ "$ref": "Operation"
+ }
}
},
- "id": "CustomHttpPattern"
+ "id": "ListOperationsResponse"
},
"OperationMetadata": {
"properties": {
@@ -2694,28 +1761,72 @@
"description": "The metadata associated with a long running operation resource.",
"type": "object"
},
- "SystemParameterRule": {
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
- "type": "object",
+ "CustomHttpPattern": {
"properties": {
- "selector": {
- "type": "string",
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details."
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
},
+ "kind": {
+ "description": "The name of this custom HTTP verb.",
+ "type": "string"
+ }
+ },
+ "id": "CustomHttpPattern",
+ "description": "A custom pattern is used for defining custom HTTP verb.",
+ "type": "object"
+ },
+ "SystemParameterRule": {
+ "properties": {
"parameters": {
+ "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.",
"type": "array",
"items": {
"$ref": "SystemParameter"
- },
- "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent."
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
}
},
- "id": "SystemParameterRule"
+ "id": "SystemParameterRule",
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
+ "type": "object"
+ },
+ "VisibilityRule": {
+ "properties": {
+ "restriction": {
+ "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "id": "VisibilityRule",
+ "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
+ "type": "object"
},
"HttpRule": {
- "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST APIs. The mapping determines what portions of the request\nmessage are populated from the path, query parameters, or body of\nthe HTTP request. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor 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 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 assumes there is no HTTP 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. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the entire path as specified by its template;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card rule is useful for services that provide\ncontent to Web (HTML) clients.",
- "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": {
+ "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.",
+ "$ref": "MediaDownload"
+ },
+ "post": {
+ "description": "Used for creating a resource.",
+ "type": "string"
+ },
"additionalBindings": {
"description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).",
"type": "array",
@@ -2736,57 +1847,27 @@
"type": "string"
},
"custom": {
- "description": "Custom pattern is used for defining custom verbs.",
- "$ref": "CustomHttpPattern"
- },
- "patch": {
- "description": "Used for updating a resource.",
- "type": "string"
+ "$ref": "CustomHttpPattern",
+ "description": "Custom pattern is used for defining custom verbs."
},
"get": {
"description": "Used for listing and getting information about resources.",
"type": "string"
},
- "put": {
+ "patch": {
"description": "Used for updating a resource.",
"type": "string"
},
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
- },
- "body": {
- "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.",
- "type": "string"
- },
- "mediaDownload": {
- "$ref": "MediaDownload",
- "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration."
- },
- "post": {
- "description": "Used for creating a resource.",
+ "put": {
+ "description": "Used for updating a resource.",
"type": "string"
}
},
- "id": "HttpRule"
- },
- "VisibilityRule": {
- "description": "A visibility rule provides visibility configuration for an individual API\nelement.",
- "type": "object",
- "properties": {
- "restriction": {
- "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.",
- "type": "string"
- },
- "selector": {
- "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- },
- "id": "VisibilityRule"
+ "id": "HttpRule",
+ "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST APIs. The mapping determines what portions of the request\nmessage are populated from the path, query parameters, or body of\nthe HTTP request. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor 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 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 assumes there is no HTTP 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. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the entire path as specified by its template;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card rule is useful for services that provide\ncontent to Web (HTML) clients.",
+ "type": "object"
},
"MonitoringDestination": {
- "id": "MonitoringDestination",
"description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).",
"type": "object",
"properties": {
@@ -2801,10 +1882,10 @@
"type": "string"
}
}
- }
+ },
+ "id": "MonitoringDestination"
},
"Visibility": {
- "id": "Visibility",
"description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
"type": "object",
"properties": {
@@ -2815,34 +1896,11 @@
"$ref": "VisibilityRule"
}
}
- }
+ },
+ "id": "Visibility"
},
"ConfigChange": {
"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": {
- "type": "string",
- "enumDescriptions": [
- "No value was provided.",
- "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
- "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
- "The changed object exists in both service configurations, but its value\nis different."
- ],
- "enum": [
- "CHANGE_TYPE_UNSPECIFIED",
- "ADDED",
- "REMOVED",
- "MODIFIED"
- ],
- "description": "The type for this change, either ADDED, REMOVED, or MODIFIED."
- },
- "element": {
- "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
- "type": "string"
- },
"oldValue": {
"description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.",
"type": "string"
@@ -2853,6 +1911,30 @@
"items": {
"$ref": "Advice"
}
+ },
+ "newValue": {
+ "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED.",
+ "type": "string"
+ },
+ "changeType": {
+ "enum": [
+ "CHANGE_TYPE_UNSPECIFIED",
+ "ADDED",
+ "REMOVED",
+ "MODIFIED"
+ ],
+ "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.",
+ "type": "string",
+ "enumDescriptions": [
+ "No value was provided.",
+ "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.",
+ "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.",
+ "The changed object exists in both service configurations, but its value\nis different."
+ ]
+ },
+ "element": {
+ "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]",
+ "type": "string"
}
},
"id": "ConfigChange",
@@ -2874,6 +1956,7 @@
"id": "SystemParameters"
},
"Rollout": {
+ "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.",
"type": "object",
"properties": {
"rolloutId": {
@@ -2881,8 +1964,8 @@
"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": {
"description": "Creation time of the rollout. Readonly.",
@@ -2914,29 +1997,1029 @@
"type": "string"
},
"trafficPercentStrategy": {
- "$ref": "TrafficPercentStrategy",
- "description": "Google Service Control selects service configurations based on\ntraffic percentage."
+ "description": "Google Service Control selects service configurations based on\ntraffic percentage.",
+ "$ref": "TrafficPercentStrategy"
},
"createdBy": {
- "type": "string",
- "description": "The user who created the Rollout. Readonly."
+ "description": "The user who created the Rollout. Readonly.",
+ "type": "string"
}
},
- "id": "Rollout",
- "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config."
+ "id": "Rollout"
+ },
+ "GenerateConfigReportRequest": {
+ "properties": {
+ "oldConfig": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
+ "type": "object"
+ },
+ "newConfig": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service",
+ "type": "object"
+ }
+ },
+ "id": "GenerateConfigReportRequest",
+ "description": "Request message for GenerateConfigReport method.",
+ "type": "object"
+ },
+ "SetIamPolicyRequest": {
+ "description": "Request message for `SetIamPolicy` method.",
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "Step": {
+ "description": "Represents the status of one operation step.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "enumDescriptions": [
+ "Unspecifed code.",
+ "The operation or step has completed without errors.",
+ "The operation or step has not started yet.",
+ "The operation or step is in progress.",
+ "The operation or step has completed with errors.",
+ "The operation or step has completed with cancellation."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DONE",
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "The status code.",
+ "type": "string"
+ },
+ "description": {
+ "description": "The short description of the step.",
+ "type": "string"
+ }
+ },
+ "id": "Step"
+ },
+ "DeleteServiceStrategy": {
+ "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.",
+ "type": "object",
+ "properties": {},
+ "id": "DeleteServiceStrategy"
+ },
+ "LoggingDestination": {
+ "properties": {
+ "logs": {
+ "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "monitoredResource": {
+ "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.",
+ "type": "string"
+ }
+ },
+ "id": "LoggingDestination",
+ "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).",
+ "type": "object"
+ },
+ "Option": {
+ "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.",
+ "type": "string"
+ }
+ },
+ "id": "Option"
+ },
+ "Logging": {
+ "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "LoggingDestination"
+ }
+ }
+ },
+ "id": "Logging"
+ },
+ "Method": {
+ "properties": {
+ "responseTypeUrl": {
+ "description": "The URL of the output message type.",
+ "type": "string"
+ },
+ "options": {
+ "description": "Any metadata attached to the method.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "responseStreaming": {
+ "description": "If true, the response is streamed.",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "The simple name of this method.",
+ "type": "string"
+ },
+ "requestTypeUrl": {
+ "description": "A URL of the input message type.",
+ "type": "string"
+ },
+ "requestStreaming": {
+ "description": "If true, the request is streamed.",
+ "type": "boolean"
+ },
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax of this method.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ]
+ }
+ },
+ "id": "Method",
+ "description": "Method represents a method of an api.",
+ "type": "object"
+ },
+ "ListServiceRolloutsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
+ },
+ "rollouts": {
+ "description": "The list of rollout resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Rollout"
+ }
+ }
+ },
+ "id": "ListServiceRolloutsResponse",
+ "description": "Response message for ListServiceRollouts method.",
+ "type": "object"
+ },
+ "ConfigRef": {
+ "properties": {
+ "name": {
+ "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".",
+ "type": "string"
+ }
+ },
+ "id": "ConfigRef",
+ "description": "Represents a service configuration with its name and id.",
+ "type": "object"
+ },
+ "Mixin": {
+ "description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand 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 API plus the root path if specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The fully qualified name of the API which is included.",
+ "type": "string"
+ },
+ "root": {
+ "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.",
+ "type": "string"
+ }
+ },
+ "id": "Mixin"
+ },
+ "CustomError": {
+ "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
+ "type": "object",
+ "properties": {
+ "types": {
+ "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rules": {
+ "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "CustomErrorRule"
+ }
+ }
+ },
+ "id": "CustomError"
+ },
+ "CounterOptions": {
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
+ "id": "CounterOptions",
+ "description": "Options for counters",
+ "type": "object"
+ },
+ "Http": {
+ "description": "Defines the HTTP configuration for a service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "HttpRule"
+ }
+ }
+ },
+ "id": "Http"
+ },
+ "SourceInfo": {
+ "properties": {
+ "sourceFiles": {
+ "description": "All files used during config generation.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ }
+ },
+ "id": "SourceInfo",
+ "description": "Source information used to create a Service Config",
+ "type": "object"
+ },
+ "Control": {
+ "properties": {
+ "environment": {
+ "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.",
+ "type": "string"
+ }
+ },
+ "id": "Control",
+ "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.",
+ "type": "object"
+ },
+ "SystemParameter": {
+ "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.",
+ "type": "object",
+ "properties": {
+ "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": {
+ "kind": {
+ "enum": [
+ "TYPE_UNKNOWN",
+ "TYPE_DOUBLE",
+ "TYPE_FLOAT",
+ "TYPE_INT64",
+ "TYPE_UINT64",
+ "TYPE_INT32",
+ "TYPE_FIXED64",
+ "TYPE_FIXED32",
+ "TYPE_BOOL",
+ "TYPE_STRING",
+ "TYPE_GROUP",
+ "TYPE_MESSAGE",
+ "TYPE_BYTES",
+ "TYPE_UINT32",
+ "TYPE_ENUM",
+ "TYPE_SFIXED32",
+ "TYPE_SFIXED64",
+ "TYPE_SINT32",
+ "TYPE_SINT64"
+ ],
+ "description": "The field type.",
+ "type": "string",
+ "enumDescriptions": [
+ "Field type unknown.",
+ "Field type double.",
+ "Field type float.",
+ "Field type int64.",
+ "Field type uint64.",
+ "Field type int32.",
+ "Field type fixed64.",
+ "Field type fixed32.",
+ "Field type bool.",
+ "Field type string.",
+ "Field type group. Proto2 syntax only, and deprecated.",
+ "Field type message.",
+ "Field type bytes.",
+ "Field type uint32.",
+ "Field type enum.",
+ "Field type sfixed32.",
+ "Field type sfixed64.",
+ "Field type sint32.",
+ "Field type sint64."
+ ]
+ },
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ },
+ "oneofIndex": {
+ "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
+ },
+ "cardinality": {
+ "enumDescriptions": [
+ "For fields with unknown cardinality.",
+ "For optional fields.",
+ "For required fields. Proto2 syntax only.",
+ "For repeated fields."
+ ],
+ "enum": [
+ "CARDINALITY_UNKNOWN",
+ "CARDINALITY_OPTIONAL",
+ "CARDINALITY_REQUIRED",
+ "CARDINALITY_REPEATED"
+ ],
+ "description": "The field cardinality.",
+ "type": "string"
+ },
+ "defaultValue": {
+ "description": "The string value of the default value of this field. Proto2 syntax only.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The field name.",
+ "type": "string"
+ },
+ "typeUrl": {
+ "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
+ "type": "string"
+ },
+ "number": {
+ "description": "The field number.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Field"
+ },
+ "Monitoring": {
+ "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
+ "type": "object",
+ "properties": {
+ "consumerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ }
+ },
+ "id": "Monitoring"
+ },
+ "TestIamPermissionsRequest": {
+ "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"
+ },
+ "Enum": {
+ "properties": {
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Enum type name.",
+ "type": "string"
+ },
+ "enumvalue": {
+ "description": "Enum value definitions.",
+ "type": "array",
+ "items": {
+ "$ref": "EnumValue"
+ }
+ },
+ "options": {
+ "description": "Protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Enum",
+ "description": "Enum type definition.",
+ "type": "object"
+ },
+ "LabelDescriptor": {
+ "properties": {
+ "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"
+ },
+ "description": {
+ "description": "A human-readable description for the label.",
+ "type": "string"
+ }
+ },
+ "id": "LabelDescriptor",
+ "description": "A description of a label.",
+ "type": "object"
+ },
+ "Diagnostic": {
+ "properties": {
+ "kind": {
+ "enum": [
+ "WARNING",
+ "ERROR"
+ ],
+ "description": "The kind of diagnostic information provided.",
+ "type": "string",
+ "enumDescriptions": [
+ "Warnings and errors",
+ "Only errors"
+ ]
+ },
+ "message": {
+ "description": "Message describing the error or warning.",
+ "type": "string"
+ },
+ "location": {
+ "description": "File name and line number of the error or warning.",
+ "type": "string"
+ }
+ },
+ "id": "Diagnostic",
+ "description": "Represents a diagnostic message (error or warning)",
+ "type": "object"
+ },
+ "EnableServiceRequest": {
+ "description": "Request message for EnableService method.",
+ "type": "object",
+ "properties": {
+ "consumerId": {
+ "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.",
+ "type": "string"
+ }
+ },
+ "id": "EnableServiceRequest"
+ },
+ "Type": {
+ "description": "A protocol buffer message type.",
+ "type": "object",
+ "properties": {
+ "syntax": {
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ],
+ "description": "The source syntax.",
+ "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"
+ }
+ },
+ "fields": {
+ "description": "The list of fields.",
+ "type": "array",
+ "items": {
+ "$ref": "Field"
+ }
+ },
+ "name": {
+ "description": "The fully qualified message name.",
+ "type": "string"
+ },
+ "oneofs": {
+ "description": "The list of types appearing in `oneof` definitions in this type.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Type"
+ },
+ "GenerateConfigReportResponse": {
+ "properties": {
+ "id": {
+ "description": "ID of the service configuration this report belongs to.",
+ "type": "string"
+ },
+ "diagnostics": {
+ "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.",
+ "type": "array",
+ "items": {
+ "$ref": "Diagnostic"
+ }
+ },
+ "serviceName": {
+ "description": "Name of the service this report belongs to.",
+ "type": "string"
+ },
+ "changeReports": {
+ "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.",
+ "type": "array",
+ "items": {
+ "$ref": "ChangeReport"
+ }
+ }
+ },
+ "id": "GenerateConfigReportResponse",
+ "description": "Response message for GenerateConfigReport method.",
+ "type": "object"
+ },
+ "ListServiceConfigsResponse": {
+ "description": "Response message for ListServiceConfigs method.",
+ "type": "object",
+ "properties": {
+ "serviceConfigs": {
+ "description": "The list of service configuration resources.",
+ "type": "array",
+ "items": {
+ "$ref": "Service"
+ }
+ },
+ "nextPageToken": {
+ "description": "The token of the next page of results.",
+ "type": "string"
+ }
+ },
+ "id": "ListServiceConfigsResponse"
+ },
+ "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": {
+ "properties": {
+ "rules": {
+ "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "BackendRule"
+ }
+ }
+ },
+ "id": "Backend",
+ "description": "`Backend` defines the backend configuration for a service.",
+ "type": "object"
+ },
+ "AuditConfig": {
+ "properties": {
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "AuditConfig",
+ "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 AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\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"
+ },
+ "SubmitConfigSourceRequest": {
+ "description": "Request message for SubmitConfigSource method.",
+ "type": "object",
+ "properties": {
+ "validateOnly": {
+ "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.",
+ "type": "boolean"
+ },
+ "configSource": {
+ "description": "The source configuration for the service.",
+ "$ref": "ConfigSource"
+ }
+ },
+ "id": "SubmitConfigSourceRequest"
+ },
+ "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": {
+ "properties": {
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "provided": {
+ "description": "A list of full type names of provided contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "ContextRule",
+ "description": "A context rule provides information about the context for an individual API\nelement.",
+ "type": "object"
+ },
+ "CloudAuditOptions": {
+ "properties": {},
+ "id": "CloudAuditOptions",
+ "description": "Write a Cloud Audit log",
+ "type": "object"
+ },
+ "MetricDescriptor": {
+ "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": {
+ "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": {
+ "enum": [
+ "METRIC_KIND_UNSPECIFIED",
+ "GAUGE",
+ "DELTA",
+ "CUMULATIVE"
+ ],
+ "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
+ "type": "string",
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "An instantaneous measurement of a value.",
+ "The change in a value during a time interval.",
+ "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
+ ]
+ },
+ "description": {
+ "description": "A detailed description of the metric, which can be used in documentation.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
+ "type": "string"
+ },
+ "unit": {
+ "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ },
+ "id": "MetricDescriptor",
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
+ "type": "object"
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "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"
+ },
+ "ListServicesResponse": {
+ "properties": {
+ "services": {
+ "description": "The returned services will only have the name field set.",
+ "type": "array",
+ "items": {
+ "$ref": "ManagedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListServices` to resume a paginated query.",
+ "type": "string"
+ }
+ },
+ "id": "ListServicesResponse",
+ "description": "Response message for `ListServices` method.",
+ "type": "object"
+ },
+ "Endpoint": {
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The canonical name of this endpoint.",
+ "type": "string"
+ },
+ "apis": {
+ "description": "The list of APIs served by this endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "aliases": {
+ "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "features": {
+ "description": "The list of features enabled on this endpoint.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "allowCors": {
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
+ "type": "boolean"
+ }
+ },
+ "id": "Endpoint"
+ },
+ "OAuthRequirements": {
+ "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
+ "type": "object",
+ "properties": {
+ "canonicalScopes": {
+ "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read",
+ "type": "string"
+ }
+ },
+ "id": "OAuthRequirements"
+ },
+ "Usage": {
+ "description": "Configuration controlling usage of a service.",
+ "type": "object",
+ "properties": {
+ "producerNotificationChannel": {
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "UsageRule"
+ }
+ },
+ "requirements": {
+ "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Usage"
+ },
+ "GetIamPolicyRequest": {
+ "description": "Request message for `GetIamPolicy` method.",
+ "type": "object",
+ "properties": {},
+ "id": "GetIamPolicyRequest"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "Context": {
+ "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "ContextRule"
+ }
+ }
+ },
+ "id": "Context"
}
},
- "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://servicemanagement.googleapis.com/",
"canonicalName": "Service Management",
"auth": {
"oauth2": {
"scopes": {
+ "https://www.googleapis.com/auth/service.management": {
+ "description": "Manage your Google API service configuration"
+ },
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
@@ -2945,14 +3028,13 @@
},
"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"
}
}
}
},
+ "kind": "discovery#restDescription",
"servicePath": "",
"description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.",
- "kind": "discovery#restDescription"
+ "rootUrl": "https://servicemanagement.googleapis.com/",
+ "basePath": ""
}
diff --git a/servicemanagement/v1/servicemanagement-gen.go b/servicemanagement/v1/servicemanagement-gen.go
index fd6712b..31cbf3d 100644
--- a/servicemanagement/v1/servicemanagement-gen.go
+++ b/servicemanagement/v1/servicemanagement-gen.go
@@ -247,9 +247,9 @@
}
// AuditConfig: Specifies the audit configuration for a service.
-// It consists of which permission types are logged, and what
-// identities, if
-// any, are exempted from logging.
+// The configuration determines which permission types are logged, and
+// what
+// identities, if any, are exempted from logging.
// An AuditConifg must have one or more AuditLogConfigs.
//
// If there are AuditConfigs for both `allServices` and a specific
@@ -2555,6 +2555,43 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// ListOperationsResponse: The response message for
+// Operations.ListOperations.
+type ListOperationsResponse struct {
+ // NextPageToken: The standard List next-page token.
+ NextPageToken string `json:"nextPageToken,omitempty"`
+
+ // Operations: A list of operations that matches the specified filter in
+ // the request.
+ Operations []*Operation `json:"operations,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 *ListOperationsResponse) MarshalJSON() ([]byte, error) {
+ type noMethod ListOperationsResponse
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// ListServiceConfigsResponse: Response message for ListServiceConfigs
// method.
type ListServiceConfigsResponse struct {
@@ -4247,6 +4284,10 @@
// manage consumption of the service, etc.
ProducerProjectId string `json:"producerProjectId,omitempty"`
+ // SourceInfo: Output only. The source information for this
+ // configuration if available.
+ SourceInfo *SourceInfo `json:"sourceInfo,omitempty"`
+
// SystemParameters: System parameter configuration.
SystemParameters *SystemParameters `json:"systemParameters,omitempty"`
@@ -4322,9 +4363,9 @@
// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the
// policy to modify. Only
- // the fields in the mask will be modified. If no mask is provided, a
- // default
- // mask is used:
+ // the fields in the mask will be modified. If no mask is provided,
+ // the
+ // following default mask is used:
// paths: "bindings, etag"
// This field is only used by Cloud IAM.
UpdateMask string `json:"updateMask,omitempty"`
@@ -4385,6 +4426,34 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// SourceInfo: Source information used to create a Service Config
+type SourceInfo struct {
+ // SourceFiles: All files used during config generation.
+ SourceFiles []googleapi.RawMessage `json:"sourceFiles,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "SourceFiles") 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. "SourceFiles") 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 *SourceInfo) MarshalJSON() ([]byte, error) {
+ type noMethod SourceInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Status: The `Status` type defines a logical error model that is
// suitable for different
// programming environments, including REST APIs and RPC APIs. It is
@@ -5353,6 +5422,212 @@
}
+// method id "servicemanagement.operations.list":
+
+type OperationsListCall struct {
+ s *APIService
+ name string
+ urlParams_ gensupport.URLParams
+ ifNoneMatch_ string
+ ctx_ context.Context
+ header_ http.Header
+}
+
+// List: 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 below allows API services to override the
+// binding
+// to use different resource name schemes, such as `users/*/operations`.
+func (r *OperationsService) List(name string) *OperationsListCall {
+ c := &OperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)}
+ c.name = name
+ return c
+}
+
+// Filter sets the optional parameter "filter": The standard list
+// filter.
+func (c *OperationsListCall) Filter(filter string) *OperationsListCall {
+ c.urlParams_.Set("filter", filter)
+ return c
+}
+
+// PageSize sets the optional parameter "pageSize": The standard list
+// page size.
+func (c *OperationsListCall) PageSize(pageSize int64) *OperationsListCall {
+ c.urlParams_.Set("pageSize", fmt.Sprint(pageSize))
+ return c
+}
+
+// PageToken sets the optional parameter "pageToken": The standard list
+// page token.
+func (c *OperationsListCall) PageToken(pageToken string) *OperationsListCall {
+ 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 *OperationsListCall) Fields(s ...googleapi.Field) *OperationsListCall {
+ 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 *OperationsListCall) IfNoneMatch(entityTag string) *OperationsListCall {
+ 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 *OperationsListCall) Context(ctx context.Context) *OperationsListCall {
+ 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 *OperationsListCall) Header() http.Header {
+ if c.header_ == nil {
+ c.header_ = make(http.Header)
+ }
+ return c.header_
+}
+
+func (c *OperationsListCall) 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())
+ reqHeaders.Set("x-goog-api-client", c.s.clientHeader())
+ 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, "v1/{+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 "servicemanagement.operations.list" call.
+// Exactly one of *ListOperationsResponse or error will be non-nil. Any
+// non-2xx status code is an error. Response headers are in either
+// *ListOperationsResponse.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 *OperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, 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 := &ListOperationsResponse{
+ 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 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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ // "flatPath": "v1/operations",
+ // "httpMethod": "GET",
+ // "id": "servicemanagement.operations.list",
+ // "parameterOrder": [
+ // "name"
+ // ],
+ // "parameters": {
+ // "filter": {
+ // "description": "The standard list filter.",
+ // "location": "query",
+ // "type": "string"
+ // },
+ // "name": {
+ // "description": "The name of the operation collection.",
+ // "location": "path",
+ // "pattern": "^operations$",
+ // "required": true,
+ // "type": "string"
+ // },
+ // "pageSize": {
+ // "description": "The standard list page size.",
+ // "format": "int32",
+ // "location": "query",
+ // "type": "integer"
+ // },
+ // "pageToken": {
+ // "description": "The standard list page token.",
+ // "location": "query",
+ // "type": "string"
+ // }
+ // },
+ // "path": "v1/{+name}",
+ // "response": {
+ // "$ref": "ListOperationsResponse"
+ // },
+ // "scopes": [
+ // "https://www.googleapis.com/auth/cloud-platform",
+ // "https://www.googleapis.com/auth/service.management"
+ // ]
+ // }
+
+}
+
+// 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 *OperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) 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 "servicemanagement.services.create":
type ServicesCreateCall struct {
@@ -5624,8 +5899,10 @@
header_ http.Header
}
-// Disable: Disable a managed service for a
-// project.
+// Disable: Disables a service for a project, so it can no longer be
+// be used for the project. It prevents accidental usage that may
+// cause
+// unexpected billing charges or security leaks.
//
// Operation<response: DisableServiceResponse>
func (r *ServicesService) Disable(serviceName string, disableservicerequest *DisableServiceRequest) *ServicesDisableCall {
@@ -5722,7 +5999,7 @@
}
return ret, nil
// {
- // "description": "Disable a managed service for a project.\n\nOperation\u003cresponse: DisableServiceResponse\u003e",
+ // "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",
// "flatPath": "v1/services/{serviceName}:disable",
// "httpMethod": "POST",
// "id": "servicemanagement.services.disable",
@@ -5763,13 +6040,13 @@
header_ http.Header
}
-// Enable: Enable a managed service for a project with default
-// setting.
+// Enable: Enables a service for a project, so it can be used
+// for the project. See
+// [Cloud Auth Guide](https://cloud.google.com/docs/authentication)
+// for
+// more information.
//
// Operation<response: EnableServiceResponse>
-//
-// google.rpc.Status errors may contain a
-// google.rpc.PreconditionFailure error detail.
func (r *ServicesService) Enable(serviceName string, enableservicerequest *EnableServiceRequest) *ServicesEnableCall {
c := &ServicesEnableCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.serviceName = serviceName
@@ -5864,7 +6141,7 @@
}
return ret, nil
// {
- // "description": "Enable a managed service for a project with default setting.\n\nOperation\u003cresponse: EnableServiceResponse\u003e\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail.",
+ // "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",
// "flatPath": "v1/services/{serviceName}:enable",
// "httpMethod": "POST",
// "id": "servicemanagement.services.enable",
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json
index e661b2a..c11c2e7 100644
--- a/serviceuser/v1/serviceuser-api.json
+++ b/serviceuser/v1/serviceuser-api.json
@@ -1,477 +1,8 @@
{
- "baseUrl": "https://serviceuser.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
- "basePath": "",
- "revision": "20170227",
- "documentationLink": "https://cloud.google.com/service-management/",
- "id": "serviceuser:v1",
- "discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "Context": {
- "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.",
- "type": "object",
- "properties": {
- "rules": {
- "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "ContextRule"
- }
- }
- },
- "id": "Context"
- },
- "LogDescriptor": {
- "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
- "type": "object",
- "properties": {
- "labels": {
- "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
- "name": {
- "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
- "type": "string"
- },
- "description": {
- "type": "string",
- "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details."
- },
- "displayName": {
- "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
- "type": "string"
- }
- },
- "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"
- },
- "displayName": {
- "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
- "type": "string"
- },
- "description": {
- "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
- "type": "string"
- },
- "type": {
- "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
- "type": "string"
- },
- "labels": {
- "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- }
- },
- "id": "MonitoredResourceDescriptor"
- },
- "MediaDownload": {
- "id": "MediaDownload",
- "description": "Use 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 THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
- "type": "string"
- }
- }
- },
- "DisableServiceRequest": {
- "description": "Request message for DisableService method.",
- "type": "object",
- "properties": {},
- "id": "DisableServiceRequest"
- },
- "SearchServicesResponse": {
- "description": "Response message for SearchServices method.",
- "type": "object",
- "properties": {
- "services": {
- "type": "array",
- "items": {
- "$ref": "PublishedService"
- },
- "description": "Services available publicly or available to the authenticated caller."
- },
- "nextPageToken": {
- "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
- "type": "string"
- }
- },
- "id": "SearchServicesResponse"
- },
- "MediaUpload": {
- "type": "object",
- "properties": {
- "uploadService": {
- "type": "string",
- "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload."
- },
- "enabled": {
- "description": "Whether upload is enabled.",
- "type": "boolean"
- }
- },
- "id": "MediaUpload",
- "description": "Use 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."
- },
- "UsageRule": {
- "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
- "type": "object",
- "properties": {
- "selector": {
- "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "allowUnregisteredCalls": {
- "description": "True, if the method allows unregistered calls; false otherwise.",
- "type": "boolean"
- }
- },
- "id": "UsageRule"
- },
- "AuthRequirement": {
- "id": "AuthRequirement",
- "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "providerId": {
- "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
- "type": "string"
- },
- "audiences": {
- "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- }
- }
- },
- "Documentation": {
- "type": "object",
- "properties": {
- "summary": {
- "description": "A short summary of what the service does. Can only be provided by\nplain text.",
- "type": "string"
- },
- "documentationRootUrl": {
- "description": "The URL to the root of documentation.",
- "type": "string"
- },
- "rules": {
- "type": "array",
- "items": {
- "$ref": "DocumentationRule"
- },
- "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
- },
- "overview": {
- "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
- "type": "string"
- },
- "pages": {
- "description": "The top level pages for the documentation set.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- }
- },
- "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."
- },
- "AuthenticationRule": {
- "type": "object",
- "properties": {
- "requirements": {
- "description": "Requirements for additional authentication providers.",
- "type": "array",
- "items": {
- "$ref": "AuthRequirement"
- }
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- },
- "allowWithoutCredential": {
- "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
- "type": "boolean"
- },
- "oauth": {
- "$ref": "OAuthRequirements",
- "description": "The requirements for OAuth credentials."
- }
- },
- "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."
- },
- "BackendRule": {
- "id": "BackendRule",
- "description": "A backend rule provides configuration for an individual API element.",
- "type": "object",
- "properties": {
- "deadline": {
- "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
- "format": "double",
- "type": "number"
- },
- "address": {
- "description": "The address of the API backend.",
- "type": "string"
- },
- "selector": {
- "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
- "type": "string"
- }
- }
- },
- "Api": {
- "id": "Api",
- "description": "Api is a light-weight descriptor for a protocol buffer service.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Any metadata attached to the API.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
- "methods": {
- "description": "The methods of this api, in unspecified order.",
- "type": "array",
- "items": {
- "$ref": "Method"
- }
- },
- "name": {
- "description": "The fully qualified name of this api, including package name\nfollowed by the api'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 api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided 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\nAPI, 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, none-GA apis.\n",
- "type": "string"
- },
- "mixins": {
- "description": "Included APIs. See Mixin.",
- "type": "array",
- "items": {
- "$ref": "Mixin"
- }
- }
- }
- },
- "Authentication": {
- "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
- "type": "object",
- "properties": {
- "providers": {
- "description": "Defines a set of authentication providers that a service supports.",
- "type": "array",
- "items": {
- "$ref": "AuthProvider"
- }
- },
- "rules": {
- "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "AuthenticationRule"
- }
- }
- },
- "id": "Authentication"
- },
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object"
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "description": "The error result of the operation in case of failure or cancellation.",
- "$ref": "Status"
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
- },
- "Page": {
- "id": "Page",
- "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
- "type": "string"
- },
- "content": {
- "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
- "type": "string"
- },
- "subpages": {
- "type": "array",
- "items": {
- "$ref": "Page"
- },
- "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset."
- }
- }
- },
- "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- }
- },
- "id": "Status"
- },
- "AuthProvider": {
- "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
- "type": "object",
- "properties": {
- "id": {
- "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
- "type": "string"
- },
- "issuer": {
- "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
- "type": "string"
- },
- "jwksUri": {
- "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs",
- "type": "string"
- },
- "audiences": {
- "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
- "type": "string"
- }
- },
- "id": "AuthProvider"
- },
"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": {
- "enums": {
- "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
- "type": "array",
- "items": {
- "$ref": "Enum"
- }
- },
- "context": {
- "description": "Context configuration.",
- "$ref": "Context"
- },
- "id": {
- "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
- "type": "string"
- },
- "usage": {
- "description": "Configuration controlling usage of this service.",
- "$ref": "Usage"
- },
- "metrics": {
- "description": "Defines the metrics used by this service.",
- "type": "array",
- "items": {
- "$ref": "MetricDescriptor"
- }
- },
- "authentication": {
- "description": "Auth configuration.",
- "$ref": "Authentication"
- },
"experimental": {
"description": "Experimental configuration.",
"$ref": "Experimental"
@@ -486,8 +17,8 @@
"type": "integer"
},
"monitoring": {
- "$ref": "Monitoring",
- "description": "Monitoring configuration."
+ "description": "Monitoring configuration.",
+ "$ref": "Monitoring"
},
"producerProjectId": {
"description": "The id of the Google developer project that owns the service.\nMembers of this project can manage the service configuration,\nmanage consumption of the service, etc.",
@@ -501,12 +32,12 @@
}
},
"visibility": {
- "$ref": "Visibility",
- "description": "API visibility configuration."
+ "description": "API visibility configuration.",
+ "$ref": "Visibility"
},
"name": {
- "type": "string",
- "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`."
+ "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.",
+ "type": "string"
},
"customError": {
"$ref": "CustomError",
@@ -544,39 +75,73 @@
"$ref": "Type"
}
},
+ "sourceInfo": {
+ "description": "Output only. The source information for this configuration if available.",
+ "$ref": "SourceInfo"
+ },
"http": {
"description": "HTTP configuration.",
"$ref": "Http"
},
+ "backend": {
+ "$ref": "Backend",
+ "description": "API backend configuration."
+ },
"systemParameters": {
"$ref": "SystemParameters",
"description": "System parameter configuration."
},
- "backend": {
- "description": "API backend configuration.",
- "$ref": "Backend"
- },
"documentation": {
"$ref": "Documentation",
"description": "Additional API documentation."
},
"logging": {
- "$ref": "Logging",
- "description": "Logging configuration."
+ "description": "Logging configuration.",
+ "$ref": "Logging"
},
"monitoredResources": {
+ "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.",
"type": "array",
"items": {
"$ref": "MonitoredResourceDescriptor"
- },
- "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations."
+ }
+ },
+ "context": {
+ "$ref": "Context",
+ "description": "Context configuration."
+ },
+ "enums": {
+ "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum",
+ "type": "array",
+ "items": {
+ "$ref": "Enum"
+ }
+ },
+ "id": {
+ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.",
+ "type": "string"
+ },
+ "usage": {
+ "$ref": "Usage",
+ "description": "Configuration controlling usage of this service."
+ },
+ "metrics": {
+ "description": "Defines the metrics used by this service.",
+ "type": "array",
+ "items": {
+ "$ref": "MetricDescriptor"
+ }
+ },
+ "authentication": {
+ "description": "Auth configuration.",
+ "$ref": "Authentication"
}
},
- "id": "Service"
+ "id": "Service",
+ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth",
+ "type": "object"
},
"EnumValue": {
- "description": "Enum value definition.",
- "type": "object",
"properties": {
"name": {
"description": "Enum value name.",
@@ -590,31 +155,77 @@
}
},
"number": {
+ "type": "integer",
"description": "Enum value number.",
+ "format": "int32"
+ }
+ },
+ "id": "EnumValue",
+ "description": "Enum value definition.",
+ "type": "object"
+ },
+ "OperationMetadata": {
+ "id": "OperationMetadata",
+ "description": "The metadata associated with a long running operation resource.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "description": "The start time of the operation.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "resourceNames": {
+ "description": "The full name of the resources that this operation is directly\nassociated with.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "steps": {
+ "description": "Detailed status information for each step. The order is undetermined.",
+ "type": "array",
+ "items": {
+ "$ref": "Step"
+ }
+ },
+ "progressPercentage": {
+ "description": "Percentage of completion of this operation, ranging from 0 to 100.",
"format": "int32",
"type": "integer"
}
- },
- "id": "EnumValue"
+ }
},
"CustomHttpPattern": {
+ "id": "CustomHttpPattern",
"description": "A custom pattern is used for defining custom HTTP verb.",
"type": "object",
"properties": {
- "path": {
- "description": "The path matched by this custom verb.",
- "type": "string"
- },
"kind": {
"description": "The name of this custom HTTP verb.",
"type": "string"
+ },
+ "path": {
+ "description": "The path matched by this custom verb.",
+ "type": "string"
}
- },
- "id": "CustomHttpPattern"
+ }
+ },
+ "PublishedService": {
+ "id": "PublishedService",
+ "description": "The published version of a Service that is managed by\nGoogle Service Management.",
+ "type": "object",
+ "properties": {
+ "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"
+ }
+ }
},
"SystemParameterRule": {
- "id": "SystemParameterRule",
- "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.",
"type": "object",
"properties": {
"parameters": {
@@ -628,43 +239,34 @@
"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"
}
- }
- },
- "PublishedService": {
- "description": "The published version of a Service that is managed by\nGoogle Service Management.",
- "type": "object",
- "properties": {
- "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"
- },
- "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"
+ "id": "SystemParameterRule",
+ "description": "Define a system parameter rule mapping system parameter definitions to\nmethods."
},
"HttpRule": {
- "id": "HttpRule",
"description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST APIs. The mapping determines what portions of the request\nmessage are populated from the path, query parameters, or body of\nthe HTTP request. The mapping is typically specified as an\n`google.api.http` annotation, see \"google/api/annotations.proto\"\nfor 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 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 assumes there is no HTTP 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. It follows the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String\nExpansion.\n\nThe syntax `**` matches zero or more path segments. It follows the semantics\nof [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved\nExpansion. NOTE: it must be the last segment in the path except the Verb.\n\nThe syntax `LITERAL` matches literal text in the URL path.\n\nThe syntax `Variable` matches the entire path as specified by its template;\nthis nested template must not contain further variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.\n\nUse CustomHttpPattern to specify any HTTP method that is not included in the\n`pattern` field, such as HEAD, or \"*\" to leave the HTTP method unspecified for\na given URL path rule. The wild-card rule is useful for services that provide\ncontent to Web (HTML) clients.",
"type": "object",
"properties": {
+ "put": {
+ "description": "Used for updating a resource.",
+ "type": "string"
+ },
+ "delete": {
+ "description": "Used for deleting a resource.",
+ "type": "string"
+ },
+ "body": {
+ "type": "string",
+ "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type."
+ },
+ "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).",
"type": "array",
@@ -677,46 +279,42 @@
"type": "string"
},
"mediaUpload": {
- "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods.",
- "$ref": "MediaUpload"
+ "$ref": "MediaUpload",
+ "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods."
},
"selector": {
"description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
},
"custom": {
- "description": "Custom pattern is used for defining custom verbs.",
- "$ref": "CustomHttpPattern"
+ "$ref": "CustomHttpPattern",
+ "description": "Custom pattern is used for defining custom verbs."
},
"patch": {
"description": "Used for updating a resource.",
"type": "string"
},
"get": {
- "description": "Used for listing and getting information about resources.",
- "type": "string"
- },
- "put": {
- "description": "Used for updating a resource.",
- "type": "string"
- },
- "delete": {
- "description": "Used for deleting a resource.",
- "type": "string"
- },
- "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": {
- "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"
+ "type": "string",
+ "description": "Used for listing and getting information about resources."
}
- }
+ },
+ "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": {
+ "type": "string",
+ "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details."
+ }
+ },
+ "id": "VisibilityRule"
},
"MonitoringDestination": {
"properties": {
@@ -737,20 +335,22 @@
"type": "object"
},
"Visibility": {
- "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.",
"type": "object",
"properties": {
"rules": {
- "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "VisibilityRule"
- }
+ },
+ "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
}
},
- "id": "Visibility"
+ "id": "Visibility",
+ "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate."
},
"SystemParameters": {
+ "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
+ "type": "object",
"properties": {
"rules": {
"description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
@@ -760,8 +360,37 @@
}
}
},
- "id": "SystemParameters",
- "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.",
+ "id": "SystemParameters"
+ },
+ "Step": {
+ "properties": {
+ "description": {
+ "type": "string",
+ "description": "The short description of the step."
+ },
+ "status": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecifed code.",
+ "The operation or step has completed without errors.",
+ "The operation or step has not started yet.",
+ "The operation or step is in progress.",
+ "The operation or step has completed with errors.",
+ "The operation or step has completed with cancellation."
+ ],
+ "enum": [
+ "STATUS_UNSPECIFIED",
+ "DONE",
+ "NOT_STARTED",
+ "IN_PROGRESS",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "description": "The status code."
+ }
+ },
+ "id": "Step",
+ "description": "Represents the status of one operation step.",
"type": "object"
},
"LoggingDestination": {
@@ -787,22 +416,21 @@
"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.",
+ "type": "object"
},
"name": {
- "type": "string",
- "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`."
+ "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": {
- "id": "Logging",
"description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history",
"type": "object",
"properties": {
@@ -820,10 +448,10 @@
"$ref": "LoggingDestination"
}
}
- }
+ },
+ "id": "Logging"
},
"Method": {
- "description": "Method represents a method of an api.",
"type": "object",
"properties": {
"responseTypeUrl": {
@@ -842,8 +470,8 @@
"type": "boolean"
},
"name": {
- "type": "string",
- "description": "The simple name of this method."
+ "description": "The simple name of this method.",
+ "type": "string"
},
"requestTypeUrl": {
"description": "A URL of the input message type.",
@@ -866,7 +494,8 @@
"type": "string"
}
},
- "id": "Method"
+ "id": "Method",
+ "description": "Method represents a method of an api."
},
"Mixin": {
"description": "Declares an API to be included in this API. The including API must\nredeclare all the methods from the included API, but documentation\nand 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 API plus the root path if 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 }",
@@ -887,24 +516,25 @@
"description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError",
"type": "object",
"properties": {
+ "rules": {
+ "type": "array",
+ "items": {
+ "$ref": "CustomErrorRule"
+ },
+ "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ },
"types": {
"description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.",
"type": "array",
"items": {
"type": "string"
}
- },
- "rules": {
- "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
- "type": "array",
- "items": {
- "$ref": "CustomErrorRule"
- }
}
},
"id": "CustomError"
},
"Http": {
+ "description": "Defines the HTTP configuration for a service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.",
"type": "object",
"properties": {
"rules": {
@@ -915,8 +545,25 @@
}
}
},
- "id": "Http",
- "description": "Defines the HTTP configuration for a service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods."
+ "id": "Http"
+ },
+ "SourceInfo": {
+ "description": "Source information used to create a Service Config",
+ "type": "object",
+ "properties": {
+ "sourceFiles": {
+ "description": "All files used during config generation.",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ }
+ }
+ }
+ },
+ "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.",
@@ -930,9 +577,11 @@
"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"
@@ -940,39 +589,18 @@
"httpHeader": {
"description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.",
"type": "string"
- },
- "name": {
- "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.",
- "type": "string"
}
},
- "id": "SystemParameter"
- },
- "Monitoring": {
- "id": "Monitoring",
- "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count",
- "type": "object",
- "properties": {
- "consumerDestinations": {
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- },
- "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination."
- },
- "producerDestinations": {
- "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
- "type": "array",
- "items": {
- "$ref": "MonitoringDestination"
- }
- }
- }
+ "id": "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": {
+ "jsonName": {
+ "description": "The field JSON name.",
+ "type": "string"
+ },
"kind": {
"description": "The field type.",
"type": "string",
@@ -1019,10 +647,6 @@
"TYPE_SINT64"
]
},
- "jsonName": {
- "description": "The field JSON name.",
- "type": "string"
- },
"options": {
"description": "The protocol buffer options.",
"type": "array",
@@ -1035,11 +659,9 @@
"format": "int32",
"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.",
@@ -1051,17 +673,19 @@
"CARDINALITY_OPTIONAL",
"CARDINALITY_REQUIRED",
"CARDINALITY_REPEATED"
- ],
- "description": "The field cardinality.",
- "type": "string"
+ ]
+ },
+ "packed": {
+ "description": "Whether to use alternative packed wire representation.",
+ "type": "boolean"
},
"defaultValue": {
"description": "The string value of the default value of this field. Proto2 syntax only.",
"type": "string"
},
"name": {
- "description": "The field name.",
- "type": "string"
+ "type": "string",
+ "description": "The field name."
},
"typeUrl": {
"description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.",
@@ -1073,10 +697,51 @@
"type": "integer"
}
},
- "id": "Field"
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ },
+ "producerDestinations": {
+ "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.",
+ "type": "array",
+ "items": {
+ "$ref": "MonitoringDestination"
+ }
+ }
+ },
+ "id": "Monitoring"
},
"Enum": {
+ "description": "Enum type definition.",
+ "type": "object",
"properties": {
+ "sourceContext": {
+ "description": "The source context.",
+ "$ref": "SourceContext"
+ },
+ "syntax": {
+ "description": "The source syntax.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
"name": {
"description": "Enum type name.",
"type": "string"
@@ -1094,27 +759,9 @@
"items": {
"$ref": "Option"
}
- },
- "sourceContext": {
- "description": "The source context.",
- "$ref": "SourceContext"
- },
- "syntax": {
- "enum": [
- "SYNTAX_PROTO2",
- "SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string",
- "enumDescriptions": [
- "Syntax `proto2`.",
- "Syntax `proto3`."
- ]
}
},
- "id": "Enum",
- "description": "Enum type definition.",
- "type": "object"
+ "id": "Enum"
},
"LabelDescriptor": {
"description": "A description of a label.",
@@ -1155,13 +802,6 @@
"description": "A protocol buffer message type.",
"type": "object",
"properties": {
- "options": {
- "description": "The protocol buffer options.",
- "type": "array",
- "items": {
- "$ref": "Option"
- }
- },
"fields": {
"description": "The list of fields.",
"type": "array",
@@ -1170,17 +810,19 @@
}
},
"name": {
- "type": "string",
- "description": "The fully qualified message name."
+ "description": "The fully qualified message name.",
+ "type": "string"
},
"oneofs": {
+ "description": "The list of types appearing in `oneof` definitions in this type.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The list of types appearing in `oneof` definitions in this type."
+ }
},
"syntax": {
+ "description": "The source syntax.",
+ "type": "string",
"enumDescriptions": [
"Syntax `proto2`.",
"Syntax `proto3`."
@@ -1188,13 +830,18 @@
"enum": [
"SYNTAX_PROTO2",
"SYNTAX_PROTO3"
- ],
- "description": "The source syntax.",
- "type": "string"
+ ]
},
"sourceContext": {
"$ref": "SourceContext",
"description": "The source context."
+ },
+ "options": {
+ "description": "The protocol buffer options.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
}
},
"id": "Type"
@@ -1204,38 +851,28 @@
"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": {
+ "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
"type": "array",
"items": {
"$ref": "BackendRule"
- },
- "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order."
+ }
}
},
- "id": "Backend",
- "description": "`Backend` defines the backend configuration for a service."
- },
- "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"
- }
- }
+ "id": "Backend"
},
"DocumentationRule": {
+ "id": "DocumentationRule",
"description": "A documentation rule provides information about individual API elements.",
"type": "object",
"properties": {
@@ -1244,20 +881,37 @@
"type": "string"
},
"deprecationDescription": {
- "type": "string",
- "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`."
+ "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.",
+ "type": "string"
},
"selector": {
"description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.",
"type": "string"
}
+ }
+ },
+ "AuthorizationConfig": {
+ "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string",
+ "description": "The name of the authorization provider, such as\nfirebaserules.googleapis.com."
+ }
},
- "id": "DocumentationRule"
+ "id": "AuthorizationConfig"
},
"ContextRule": {
"description": "A context rule provides information about the context for an individual API\nelement.",
"type": "object",
"properties": {
+ "requested": {
+ "description": "A list of full type names of requested contexts.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
"selector": {
"description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
"type": "string"
@@ -1268,67 +922,13 @@
"items": {
"type": "string"
}
- },
- "requested": {
- "description": "A list of full type names of requested contexts.",
- "type": "array",
- "items": {
- "type": "string"
- }
}
},
"id": "ContextRule"
},
- "SourceContext": {
- "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
- "type": "object",
- "properties": {
- "fileName": {
- "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
- "type": "string"
- }
- },
- "id": "SourceContext"
- },
"MetricDescriptor": {
- "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.",
"type": "object",
"properties": {
- "metricKind": {
- "enum": [
- "METRIC_KIND_UNSPECIFIED",
- "GAUGE",
- "DELTA",
- "CUMULATIVE"
- ],
- "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
- "type": "string",
- "enumDescriptions": [
- "Do not use this default value.",
- "An instantaneous measurement of a value.",
- "The change in a value during a time interval.",
- "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints."
- ]
- },
- "description": {
- "description": "A detailed description of the metric, which can be used in documentation.",
- "type": "string"
- },
- "displayName": {
- "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".",
- "type": "string"
- },
- "unit": {
- "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.",
- "type": "string"
- },
- "labels": {
- "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.",
- "type": "array",
- "items": {
- "$ref": "LabelDescriptor"
- }
- },
"name": {
"description": "The resource name of the metric descriptor. 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"
@@ -1358,12 +958,58 @@
],
"description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.",
"type": "string"
+ },
+ "metricKind": {
+ "enumDescriptions": [
+ "Do not use this default value.",
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
}
},
- "id": "MetricDescriptor"
+ "id": "MetricDescriptor",
+ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable."
+ },
+ "SourceContext": {
+ "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.",
+ "type": "object",
+ "properties": {
+ "fileName": {
+ "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.",
+ "type": "string"
+ }
+ },
+ "id": "SourceContext"
},
"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": {
"apis": {
@@ -1374,32 +1020,32 @@
}
},
"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.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intented\nalias.\n\nAdditional names that this endpoint will be hosted on."
+ }
},
"features": {
+ "description": "The list of features enabled on this endpoint.",
"type": "array",
"items": {
"type": "string"
- },
- "description": "The list of features enabled on this endpoint."
+ }
},
"allowCors": {
- "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed."
},
"name": {
"description": "The canonical name of this endpoint.",
"type": "string"
}
},
- "id": "Endpoint"
+ "id": "Endpoint",
+ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true"
},
"ListEnabledServicesResponse": {
- "type": "object",
"properties": {
"services": {
"description": "Services enabled for the specified parent.",
@@ -1414,7 +1060,8 @@
}
},
"id": "ListEnabledServicesResponse",
- "description": "Response message for `ListEnabledServices` method."
+ "description": "Response message for `ListEnabledServices` method.",
+ "type": "object"
},
"OAuthRequirements": {
"description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.",
@@ -1428,12 +1075,11 @@
"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"
+ "type": "string",
+ "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview."
},
"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.",
@@ -1450,12 +1096,441 @@
}
}
},
- "id": "Usage"
+ "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.",
+ "type": "array",
+ "items": {
+ "$ref": "ContextRule"
+ }
+ }
+ },
+ "id": "Context"
+ },
+ "LogDescriptor": {
+ "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].",
+ "type": "string"
+ },
+ "description": {
+ "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ },
+ "id": "LogDescriptor"
+ },
+ "CustomErrorRule": {
+ "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",
+ "description": "A custom error rule."
+ },
+ "MonitoredResourceDescriptor": {
+ "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.",
+ "type": "string"
+ },
+ "labels": {
+ "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.",
+ "type": "array",
+ "items": {
+ "$ref": "LabelDescriptor"
+ }
+ }
+ },
+ "id": "MonitoredResourceDescriptor"
+ },
+ "MediaDownload": {
+ "id": "MediaDownload",
+ "description": "Use 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": {
+ "type": "boolean",
+ "description": "Whether download is enabled."
+ },
+ "downloadService": {
+ "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.",
+ "type": "string"
+ }
+ }
+ },
+ "DisableServiceRequest": {
+ "description": "Request message for DisableService method.",
+ "type": "object",
+ "properties": {},
+ "id": "DisableServiceRequest"
+ },
+ "SearchServicesResponse": {
+ "properties": {
+ "services": {
+ "description": "Services available publicly or available to the authenticated caller.",
+ "type": "array",
+ "items": {
+ "$ref": "PublishedService"
+ }
+ },
+ "nextPageToken": {
+ "description": "Token that can be passed to `ListAvailableServices` to resume a paginated\nquery.",
+ "type": "string"
+ }
+ },
+ "id": "SearchServicesResponse",
+ "description": "Response message for SearchServices method.",
+ "type": "object"
+ },
+ "MediaUpload": {
+ "properties": {
+ "enabled": {
+ "description": "Whether upload is enabled.",
+ "type": "boolean"
+ },
+ "uploadService": {
+ "description": "DO NOT USE THIS FIELD UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.",
+ "type": "string"
+ }
+ },
+ "id": "MediaUpload",
+ "description": "Use 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"
+ },
+ "UsageRule": {
+ "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true",
+ "type": "object",
+ "properties": {
+ "allowUnregisteredCalls": {
+ "description": "True, if the method allows unregistered calls; false otherwise.",
+ "type": "boolean"
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ }
+ },
+ "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": {
+ "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ },
+ "providerId": {
+ "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth",
+ "type": "string"
+ }
+ },
+ "id": "AuthRequirement"
+ },
+ "Documentation": {
+ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.",
+ "type": "object",
+ "properties": {
+ "pages": {
+ "description": "The top level pages for the documentation set.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "summary": {
+ "description": "A short summary of what the service does. Can only be provided by\nplain text.",
+ "type": "string"
+ },
+ "documentationRootUrl": {
+ "description": "The URL to the root of documentation.",
+ "type": "string"
+ },
+ "rules": {
+ "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "DocumentationRule"
+ }
+ },
+ "overview": {
+ "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.",
+ "type": "string"
+ }
+ },
+ "id": "Documentation"
+ },
+ "AuthenticationRule": {
+ "properties": {
+ "requirements": {
+ "description": "Requirements for additional authentication providers.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthRequirement"
+ }
+ },
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "allowWithoutCredential": {
+ "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.",
+ "type": "boolean"
+ },
+ "oauth": {
+ "description": "The requirements for OAuth credentials.",
+ "$ref": "OAuthRequirements"
+ }
+ },
+ "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"
+ },
+ "BackendRule": {
+ "description": "A backend rule provides configuration for an individual API element.",
+ "type": "object",
+ "properties": {
+ "selector": {
+ "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.",
+ "type": "string"
+ },
+ "deadline": {
+ "description": "The number of seconds to wait for a response from a request. The\ndefault depends on the deployment context.",
+ "format": "double",
+ "type": "number"
+ },
+ "address": {
+ "description": "The address of the API backend.",
+ "type": "string"
+ }
+ },
+ "id": "BackendRule"
+ },
+ "Api": {
+ "type": "object",
+ "properties": {
+ "methods": {
+ "description": "The methods of this api, in unspecified order.",
+ "type": "array",
+ "items": {
+ "$ref": "Method"
+ }
+ },
+ "name": {
+ "description": "The fully qualified name of this api, including package name\nfollowed by the api's simple name.",
+ "type": "string"
+ },
+ "syntax": {
+ "description": "The source syntax of the service.",
+ "type": "string",
+ "enumDescriptions": [
+ "Syntax `proto2`.",
+ "Syntax `proto3`."
+ ],
+ "enum": [
+ "SYNTAX_PROTO2",
+ "SYNTAX_PROTO3"
+ ]
+ },
+ "sourceContext": {
+ "$ref": "SourceContext",
+ "description": "Source context for the protocol buffer service represented by this\nmessage."
+ },
+ "version": {
+ "type": "string",
+ "description": "A version string for this api. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version\nis omitted, it defaults to zero. If the entire version field is\nempty, the major version is derived from the package name, as\noutlined below. If the field is not empty, the version in the\npackage name will be verified to be consistent with what is\nprovided 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\nAPI, 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, none-GA apis.\n"
+ },
+ "mixins": {
+ "type": "array",
+ "items": {
+ "$ref": "Mixin"
+ },
+ "description": "Included APIs. See Mixin."
+ },
+ "options": {
+ "description": "Any metadata attached to the API.",
+ "type": "array",
+ "items": {
+ "$ref": "Option"
+ }
+ }
+ },
+ "id": "Api",
+ "description": "Api is a light-weight descriptor for a protocol buffer service."
+ },
+ "Authentication": {
+ "type": "object",
+ "properties": {
+ "rules": {
+ "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthenticationRule"
+ }
+ },
+ "providers": {
+ "description": "Defines a set of authentication providers that a service supports.",
+ "type": "array",
+ "items": {
+ "$ref": "AuthProvider"
+ }
+ }
+ },
+ "id": "Authentication",
+ "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "response": {
+ "type": "object",
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`."
+ }
+ },
+ "id": "Operation"
+ },
+ "Page": {
+ "type": "object",
+ "properties": {
+ "content": {
+ "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.",
+ "type": "string"
+ },
+ "subpages": {
+ "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "name": {
+ "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.",
+ "type": "string"
+ }
+ },
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
+ "type": "object",
+ "properties": {
+ "details": {
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use."
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "id": "Status"
+ },
+ "AuthProvider": {
+ "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).",
+ "type": "object",
+ "properties": {
+ "jwksUri": {
+ "type": "string",
+ "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs"
+ },
+ "audiences": {
+ "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com",
+ "type": "string"
+ },
+ "id": {
+ "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".",
+ "type": "string"
+ },
+ "issuer": {
+ "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com",
+ "type": "string"
+ }
+ },
+ "id": "AuthProvider"
}
},
"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 User",
@@ -1486,26 +1561,28 @@
"services": {
"methods": {
"list": {
- "path": "v1/{+parent}/services",
- "id": "serviceuser.projects.services.list",
- "description": "List enabled services for the specified consumer.",
"response": {
"$ref": "ListEnabledServicesResponse"
},
- "httpMethod": "GET",
"parameterOrder": [
"parent"
],
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
- "pageSize": {
- "type": "integer",
+ "pageToken": {
"location": "query",
+ "description": "Token identifying which result to start with; returned by a previous list\ncall.",
+ "type": "string"
+ },
+ "pageSize": {
"description": "Requested size of the next page of data.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
},
"parent": {
"required": true,
@@ -1513,16 +1590,18 @@
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying which result to start with; returned by a previous list\ncall.",
- "type": "string"
}
},
- "flatPath": "v1/projects/{projectsId}/services"
+ "flatPath": "v1/projects/{projectsId}/services",
+ "path": "v1/{+parent}/services",
+ "id": "serviceuser.projects.services.list",
+ "description": "List enabled services for the specified consumer."
},
"disable": {
+ "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ "request": {
+ "$ref": "DisableServiceRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -1545,20 +1624,9 @@
},
"flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
"path": "v1/{+name}:disable",
- "id": "serviceuser.projects.services.disable",
- "description": "Disable a managed service for a consumer.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
- "request": {
- "$ref": "DisableServiceRequest"
- }
+ "id": "serviceuser.projects.services.disable"
},
"enable": {
- "httpMethod": "POST",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Operation"
- },
"parameters": {
"name": {
"location": "path",
@@ -1573,12 +1641,19 @@
"https://www.googleapis.com/auth/service.management"
],
"flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
- "id": "serviceuser.projects.services.enable",
"path": "v1/{+name}:enable",
+ "id": "serviceuser.projects.services.enable",
"request": {
"$ref": "EnableServiceRequest"
},
- "description": "Enable a managed service for a consumer with the default settings.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail."
+ "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",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST"
}
}
}
@@ -1587,15 +1662,6 @@
"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.",
- "httpMethod": "GET",
- "parameterOrder": [],
- "response": {
- "$ref": "SearchServicesResponse"
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
@@ -1612,49 +1678,72 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "flatPath": "v1/services:search",
+ "path": "v1/services:search",
+ "id": "serviceuser.services.search",
+ "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.",
+ "response": {
+ "$ref": "SearchServicesResponse"
+ },
+ "httpMethod": "GET",
+ "parameterOrder": []
}
}
}
},
"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": {
+ "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true",
- "location": "query"
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
- "fields": {
- "type": "string",
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response."
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
- "alt": {
+ "$.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"
@@ -1666,17 +1755,18 @@
"json",
"media",
"proto"
- ]
+ ],
+ "type": "string"
},
"access_token": {
+ "type": "string",
"location": "query",
- "description": "OAuth access token.",
- "type": "string"
+ "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.",
- "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",
@@ -1684,26 +1774,20 @@
"type": "string"
},
"pp": {
+ "description": "Pretty-print response.",
"type": "boolean",
"default": "true",
- "location": "query",
- "description": "Pretty-print response."
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "type": "string",
- "location": "query",
- "description": "OAuth bearer token."
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "location": "query"
}
},
- "version": "v1"
+ "version": "v1",
+ "baseUrl": "https://serviceuser.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.",
+ "servicePath": "",
+ "basePath": "",
+ "revision": "20170306",
+ "documentationLink": "https://cloud.google.com/service-management/",
+ "id": "serviceuser:v1",
+ "discoveryVersion": "v1"
}
diff --git a/serviceuser/v1/serviceuser-gen.go b/serviceuser/v1/serviceuser-gen.go
index 994433f..9190c71 100644
--- a/serviceuser/v1/serviceuser-gen.go
+++ b/serviceuser/v1/serviceuser-gen.go
@@ -2674,6 +2674,49 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// OperationMetadata: The metadata associated with a long running
+// operation resource.
+type OperationMetadata struct {
+ // ProgressPercentage: Percentage of completion of this operation,
+ // ranging from 0 to 100.
+ ProgressPercentage int64 `json:"progressPercentage,omitempty"`
+
+ // ResourceNames: The full name of the resources that this operation is
+ // directly
+ // associated with.
+ ResourceNames []string `json:"resourceNames,omitempty"`
+
+ // StartTime: The start time of the operation.
+ StartTime string `json:"startTime,omitempty"`
+
+ // Steps: Detailed status information for each step. The order is
+ // undetermined.
+ Steps []*Step `json:"steps,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "ProgressPercentage")
+ // 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. "ProgressPercentage") 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 *OperationMetadata) MarshalJSON() ([]byte, error) {
+ type noMethod OperationMetadata
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Option: A protocol buffer option, which can be attached to a message,
// field,
// enumeration, etc.
@@ -2978,6 +3021,10 @@
// manage consumption of the service, etc.
ProducerProjectId string `json:"producerProjectId,omitempty"`
+ // SourceInfo: Output only. The source information for this
+ // configuration if available.
+ SourceInfo *SourceInfo `json:"sourceInfo,omitempty"`
+
// SystemParameters: System parameter configuration.
SystemParameters *SystemParameters `json:"systemParameters,omitempty"`
@@ -3070,6 +3117,34 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// SourceInfo: Source information used to create a Service Config
+type SourceInfo struct {
+ // SourceFiles: All files used during config generation.
+ SourceFiles []googleapi.RawMessage `json:"sourceFiles,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "SourceFiles") 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. "SourceFiles") 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 *SourceInfo) MarshalJSON() ([]byte, error) {
+ type noMethod SourceInfo
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// Status: The `Status` type defines a logical error model that is
// suitable for different
// programming environments, including REST APIs and RPC APIs. It is
@@ -3189,6 +3264,46 @@
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
+// Step: Represents the status of one operation step.
+type Step struct {
+ // Description: The short description of the step.
+ Description string `json:"description,omitempty"`
+
+ // Status: The status code.
+ //
+ // Possible values:
+ // "STATUS_UNSPECIFIED" - Unspecifed code.
+ // "DONE" - The operation or step has completed without errors.
+ // "NOT_STARTED" - The operation or step has not started yet.
+ // "IN_PROGRESS" - The operation or step is in progress.
+ // "FAILED" - The operation or step has completed with errors.
+ // "CANCELLED" - The operation or step has completed with
+ // cancellation.
+ Status string `json:"status,omitempty"`
+
+ // ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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 *Step) MarshalJSON() ([]byte, error) {
+ type noMethod Step
+ raw := noMethod(*s)
+ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
+}
+
// SystemParameter: Define a parameter's name and location. The
// parameter may be passed as either
// an HTTP header or a URL query parameter, and if both are passed the
@@ -3639,8 +3754,11 @@
header_ http.Header
}
-// Disable: Disable a managed service for a
-// consumer.
+// Disable: Disable a service so it can no longer be used with
+// a
+// project. This prevents unintended usage that may cause unexpected
+// billing
+// charges or security leaks.
//
// Operation<response: google.protobuf.Empty>
func (r *ProjectsServicesService) Disable(name string, disableservicerequest *DisableServiceRequest) *ProjectsServicesDisableCall {
@@ -3737,7 +3855,7 @@
}
return ret, nil
// {
- // "description": "Disable a managed service for a consumer.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e",
+ // "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",
// "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable",
// "httpMethod": "POST",
// "id": "serviceuser.projects.services.disable",
@@ -3779,13 +3897,12 @@
header_ http.Header
}
-// Enable: Enable a managed service for a consumer with the default
-// settings.
+// Enable: Enable a service so it can be used with a project.
+// See [Cloud Auth Guide](https://cloud.google.com/docs/authentication)
+// for
+// more information.
//
// Operation<response: google.protobuf.Empty>
-//
-// google.rpc.Status errors may contain a
-// google.rpc.PreconditionFailure error detail.
func (r *ProjectsServicesService) Enable(name string, enableservicerequest *EnableServiceRequest) *ProjectsServicesEnableCall {
c := &ProjectsServicesEnableCall{s: r.s, urlParams_: make(gensupport.URLParams)}
c.name = name
@@ -3880,7 +3997,7 @@
}
return ret, nil
// {
- // "description": "Enable a managed service for a consumer with the default settings.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e\n\ngoogle.rpc.Status errors may contain a\ngoogle.rpc.PreconditionFailure error detail.",
+ // "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",
// "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable",
// "httpMethod": "POST",
// "id": "serviceuser.projects.services.enable",
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json
index e6a62c2..5e97ae9 100644
--- a/sheets/v4/sheets-api.json
+++ b/sheets/v4/sheets-api.json
@@ -1,815 +1,605 @@
{
- "schemas": {
- "PivotGroupSortValueBucket": {
- "description": "Information about which values in a pivot group should be used for sorting.",
- "type": "object",
- "properties": {
- "valuesIndex": {
- "type": "integer",
- "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
- "format": "int32"
- },
- "buckets": {
- "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
- "type": "array",
- "items": {
- "$ref": "ExtendedValue"
- }
- }
- },
- "id": "PivotGroupSortValueBucket"
- },
- "EmbeddedObjectPosition": {
- "description": "The position of an embedded object such as a chart.",
- "type": "object",
- "properties": {
- "newSheet": {
- "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
- "type": "boolean"
- },
- "sheetId": {
- "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
- "format": "int32",
- "type": "integer"
- },
- "overlayPosition": {
- "$ref": "OverlayPosition",
- "description": "The position at which the object is overlaid on top of a grid."
- }
- },
- "id": "EmbeddedObjectPosition"
- },
- "DeleteProtectedRangeRequest": {
- "type": "object",
- "properties": {
- "protectedRangeId": {
- "description": "The ID of the protected range to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteProtectedRangeRequest",
- "description": "Deletes the protected range with the given ID."
- },
- "AutoFillRequest": {
- "description": "Fills in more data based on existing data.",
- "type": "object",
- "properties": {
- "sourceAndDestination": {
- "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
- "$ref": "SourceAndDestination"
- },
- "range": {
- "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.",
- "$ref": "GridRange"
- },
- "useAlternateSeries": {
- "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
- "type": "boolean"
- }
- },
- "id": "AutoFillRequest"
- },
- "GradientRule": {
- "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
- "type": "object",
- "properties": {
- "minpoint": {
- "$ref": "InterpolationPoint",
- "description": "The starting interpolation point."
- },
- "maxpoint": {
- "description": "The final interpolation point.",
- "$ref": "InterpolationPoint"
- },
- "midpoint": {
- "description": "An optional midway interpolation point.",
- "$ref": "InterpolationPoint"
- }
- },
- "id": "GradientRule"
- },
- "SetBasicFilterRequest": {
- "description": "Sets the basic filter associated with a sheet.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "BasicFilter",
- "description": "The filter to set."
- }
- },
- "id": "SetBasicFilterRequest"
- },
- "ClearValuesRequest": {
- "type": "object",
- "properties": {},
- "id": "ClearValuesRequest",
- "description": "The request for clearing a range of values in a spreadsheet."
- },
- "InterpolationPoint": {
- "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
- "type": "object",
- "properties": {
- "type": {
- "enumDescriptions": [
- "The default value, do not use.",
- "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use the maximum value in the\ncells over the range of the conditional format.",
- "The interpolation point will use exactly the value in\nInterpolationPoint.value.",
- "The interpolation point will be the given percentage over\nall the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=(MAX(FLATTEN(range)) * (value / 100))\n + (MIN(FLATTEN(range)) * (1 - (value / 100)))`\n(where errors in the range are ignored when flattening).",
- "The interpolation point will be the given percentile\nover all the cells in the range of the conditional format.\nThis is equivalent to NUMBER if the value was:\n`=PERCENTILE(FLATTEN(range), value / 100)`\n(where errors in the range are ignored when flattening)."
- ],
- "enum": [
- "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
- "MIN",
- "MAX",
- "NUMBER",
- "PERCENT",
- "PERCENTILE"
- ],
- "description": "How the value should be interpreted.",
- "type": "string"
- },
- "value": {
- "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
- "type": "string"
- },
- "color": {
- "description": "The color this interpolation point should use.",
- "$ref": "Color"
- }
- },
- "id": "InterpolationPoint"
- },
- "FindReplaceResponse": {
- "description": "The result of the find/replace.",
- "type": "object",
- "properties": {
- "formulasChanged": {
- "description": "The number of formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
- "valuesChanged": {
- "description": "The number of non-formula cells changed.",
- "format": "int32",
- "type": "integer"
- },
- "occurrencesChanged": {
- "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
- "format": "int32",
- "type": "integer"
- },
- "rowsChanged": {
- "description": "The number of rows changed.",
- "format": "int32",
- "type": "integer"
- },
- "sheetsChanged": {
- "description": "The number of sheets changed.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "FindReplaceResponse"
- },
- "DeleteEmbeddedObjectRequest": {
- "description": "Deletes the embedded object with the given ID.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The ID of the embedded object to delete.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DeleteEmbeddedObjectRequest"
- },
- "DeleteSheetRequest": {
- "id": "DeleteSheetRequest",
- "description": "Deletes the requested sheet.",
- "type": "object",
- "properties": {
- "sheetId": {
- "description": "The ID of the sheet to delete.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "DuplicateFilterViewRequest": {
- "description": "Duplicates a particular filter view.",
- "type": "object",
- "properties": {
- "filterId": {
- "type": "integer",
- "description": "The ID of the filter being duplicated.",
- "format": "int32"
- }
- },
- "id": "DuplicateFilterViewRequest"
- },
- "UpdateConditionalFormatRuleResponse": {
- "id": "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": {
- "description": "The index of the new rule.",
- "format": "int32",
- "type": "integer"
- },
- "oldIndex": {
- "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
- "format": "int32",
- "type": "integer"
- },
- "newRule": {
- "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
- "$ref": "ConditionalFormatRule"
- }
- }
- },
- "DuplicateSheetRequest": {
- "id": "DuplicateSheetRequest",
- "description": "Duplicates the contents of a sheet.",
- "type": "object",
- "properties": {
- "newSheetId": {
- "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
- "format": "int32",
- "type": "integer"
- },
- "insertSheetIndex": {
- "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
- "format": "int32",
- "type": "integer"
- },
- "newSheetName": {
- "description": "The name of the new sheet. If empty, a new name is chosen for you.",
- "type": "string"
- },
- "sourceSheetId": {
- "description": "The sheet to duplicate.",
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "ConditionValue": {
- "description": "The value of the condition.",
- "type": "object",
- "properties": {
- "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"
- },
- "userEnteredValue": {
- "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
- "type": "string"
- }
- },
- "id": "ConditionValue"
- },
- "ExtendedValue": {
- "description": "The kinds of value that a cell in a spreadsheet can have.",
- "type": "object",
- "properties": {
- "numberValue": {
- "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
- "format": "double",
- "type": "number"
- },
- "errorValue": {
- "$ref": "ErrorValue",
- "description": "Represents an error.\nThis field is read-only."
- },
- "stringValue": {
- "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
- "type": "string"
- },
- "boolValue": {
- "description": "Represents a boolean value.",
- "type": "boolean"
- },
- "formulaValue": {
- "description": "Represents a formula.",
- "type": "string"
- }
- },
- "id": "ExtendedValue"
- },
- "BandedRange": {
- "description": "A banded (alternating colors) range in a sheet.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The range over which these properties are applied.",
- "$ref": "GridRange"
- },
- "bandedRangeId": {
- "description": "The id of the banded range.",
- "format": "int32",
- "type": "integer"
- },
- "rowProperties": {
- "$ref": "BandingProperties",
- "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
- },
- "columnProperties": {
- "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified.",
- "$ref": "BandingProperties"
- }
- },
- "id": "BandedRange"
- },
- "BatchClearValuesResponse": {
- "properties": {
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
- "clearedRanges": {
- "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "BatchClearValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object"
- },
- "Spreadsheet": {
- "description": "Resource that represents a spreadsheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "Overall properties of a spreadsheet.",
- "$ref": "SpreadsheetProperties"
- },
- "spreadsheetId": {
- "description": "The ID of the spreadsheet.\nThis field is read-only.",
- "type": "string"
- },
+ "ownerName": "Google",
+ "resources": {
+ "spreadsheets": {
+ "resources": {
"sheets": {
- "description": "The sheets that are part of a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "Sheet"
+ "methods": {
+ "copyTo": {
+ "id": "sheets.spreadsheets.sheets.copyTo",
+ "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
+ "request": {
+ "$ref": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "sheetId"
+ ],
+ "response": {
+ "$ref": "SheetProperties"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet containing the sheet to copy.",
+ "required": true,
+ "type": "string"
+ },
+ "sheetId": {
+ "location": "path",
+ "description": "The ID of the sheet to copy.",
+ "format": "int32",
+ "required": true,
+ "type": "integer"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
+ }
}
},
- "namedRanges": {
- "description": "The named ranges defined in a spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "NamedRange"
+ "values": {
+ "methods": {
+ "clear": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "ClearValuesResponse"
+ },
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to clear.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "id": "sheets.spreadsheets.values.clear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
+ "request": {
+ "$ref": "ClearValuesRequest"
+ },
+ "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
+ },
+ "batchGet": {
+ "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.",
+ "response": {
+ "$ref": "BatchGetValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string"
+ },
+ "valueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "ranges": {
+ "repeated": true,
+ "location": "query",
+ "description": "The A1 notation of the values to retrieve.",
+ "type": "string"
+ },
+ "majorDimension": {
+ "location": "query",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
+ "id": "sheets.spreadsheets.values.batchGet"
+ },
+ "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.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "response": {
+ "$ref": "AppendValuesResponse"
+ },
+ "parameters": {
+ "range": {
+ "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "includeValuesInResponse": {
+ "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"
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "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": {
+ "enum": [
+ "OVERWRITE",
+ "INSERT_ROWS"
+ ],
+ "description": "How the input data should be inserted.",
+ "type": "string",
+ "location": "query"
+ },
+ "valueInputOption": {
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "location": "query"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
+ "id": "sheets.spreadsheets.values.append",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append"
+ },
+ "batchClear": {
+ "response": {
+ "$ref": "BatchClearValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
+ "id": "sheets.spreadsheets.values.batchClear",
+ "request": {
+ "$ref": "BatchClearValuesRequest"
+ },
+ "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
+ },
+ "get": {
+ "response": {
+ "$ref": "ValueRange"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to retrieve data from.",
+ "required": true,
+ "type": "string"
+ },
+ "range": {
+ "location": "path",
+ "description": "The A1 notation of the values to retrieve.",
+ "required": true,
+ "type": "string"
+ },
+ "valueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "location": "query"
+ },
+ "dateTimeRenderOption": {
+ "location": "query",
+ "enum": [
+ "SERIAL_NUMBER",
+ "FORMATTED_STRING"
+ ],
+ "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
+ "type": "string"
+ },
+ "majorDimension": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "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."
+ },
+ "update": {
+ "response": {
+ "$ref": "UpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId",
+ "range"
+ ],
+ "httpMethod": "PUT",
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "parameters": {
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "responseValueRenderOption": {
+ "location": "query",
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string"
+ },
+ "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"
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
+ "type": "boolean",
+ "location": "query"
+ },
+ "range": {
+ "description": "The A1 notation of the values to update.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ }
+ },
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}",
+ "id": "sheets.spreadsheets.values.update",
+ "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
+ "request": {
+ "$ref": "ValueRange"
+ }
+ },
+ "batchUpdate": {
+ "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
+ "id": "sheets.spreadsheets.values.batchUpdate",
+ "request": {
+ "$ref": "BatchUpdateValuesRequest"
+ },
+ "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.",
+ "response": {
+ "$ref": "BatchUpdateValuesResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The ID of the spreadsheet to update.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate"
+ }
}
- },
- "spreadsheetUrl": {
- "description": "The url of the spreadsheet.\nThis field is read-only.",
- "type": "string"
}
},
- "id": "Spreadsheet"
- },
- "AddChartRequest": {
- "properties": {
- "chart": {
- "$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",
- "description": "Adds a chart to a sheet in the spreadsheet.",
- "type": "object"
- },
- "UpdateProtectedRangeRequest": {
- "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
- "type": "object",
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The protected range to update with the new properties."
+ "methods": {
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets",
+ "id": "sheets.spreadsheets.create",
+ "path": "v4/spreadsheets",
+ "request": {
+ "$ref": "Spreadsheet"
+ },
+ "description": "Creates a spreadsheet, returning the newly created spreadsheet."
},
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateProtectedRangeRequest"
- },
- "TextFormat": {
- "properties": {
- "underline": {
- "description": "True if the text is underlined.",
- "type": "boolean"
+ "batchUpdate": {
+ "request": {
+ "$ref": "BatchUpdateSpreadsheetRequest"
+ },
+ "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.",
+ "response": {
+ "$ref": "BatchUpdateSpreadsheetResponse"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to apply the updates to.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/spreadsheets"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
+ "id": "sheets.spreadsheets.batchUpdate"
},
- "foregroundColor": {
- "description": "The foreground color of the text.",
- "$ref": "Color"
- },
- "bold": {
- "description": "True if the text is bold.",
- "type": "boolean"
- },
- "fontFamily": {
- "description": "The font family.",
- "type": "string"
- },
- "italic": {
- "description": "True if the text is italicized.",
- "type": "boolean"
- },
- "strikethrough": {
- "description": "True if the text has a strikethrough.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the font.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextFormat",
- "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
- "type": "object"
- },
- "AddSheetResponse": {
- "id": "AddSheetResponse",
- "description": "The result of adding a sheet.",
- "type": "object",
- "properties": {
- "properties": {
- "description": "The properties of the newly added sheet.",
- "$ref": "SheetProperties"
+ "get": {
+ "path": "v4/spreadsheets/{spreadsheetId}",
+ "id": "sheets.spreadsheets.get",
+ "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.",
+ "response": {
+ "$ref": "Spreadsheet"
+ },
+ "parameterOrder": [
+ "spreadsheetId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "ranges": {
+ "repeated": true,
+ "location": "query",
+ "description": "The ranges to retrieve from the spreadsheet.",
+ "type": "string"
+ },
+ "includeGridData": {
+ "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
+ "type": "boolean",
+ "location": "query"
+ },
+ "spreadsheetId": {
+ "location": "path",
+ "description": "The spreadsheet to request.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ],
+ "flatPath": "v4/spreadsheets/{spreadsheetId}"
}
}
+ }
+ },
+ "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"
},
- "AddFilterViewResponse": {
- "id": "AddFilterViewResponse",
- "description": "The result of adding a filter view.",
- "type": "object",
- "properties": {
- "filter": {
- "$ref": "FilterView",
- "description": "The newly added filter view."
- }
- }
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
},
- "IterativeCalculationSettings": {
- "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
- "type": "object",
- "properties": {
- "maxIterations": {
- "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
- "format": "int32",
- "type": "integer"
- },
- "convergenceThreshold": {
- "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
- "format": "double",
- "type": "number"
- }
- },
- "id": "IterativeCalculationSettings"
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
},
- "OverlayPosition": {
- "id": "OverlayPosition",
- "description": "The location an object is overlaid on top of a grid.",
- "type": "object",
- "properties": {
- "offsetYPixels": {
- "type": "integer",
- "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32"
- },
- "heightPixels": {
- "description": "The height of the object, in pixels. Defaults to 371.",
- "format": "int32",
- "type": "integer"
- },
- "widthPixels": {
- "description": "The width of the object, in pixels. Defaults to 600.",
- "format": "int32",
- "type": "integer"
- },
- "offsetXPixels": {
- "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
- "format": "int32",
- "type": "integer"
- },
- "anchorCell": {
- "$ref": "GridCoordinate",
- "description": "The cell the object is anchored to."
- }
- }
+ "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"
},
- "SpreadsheetProperties": {
- "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."
- },
- "title": {
- "description": "The title of the spreadsheet.",
- "type": "string"
- },
- "timeZone": {
- "type": "string",
- "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`."
- },
- "locale": {
- "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
- "type": "string"
- },
- "iterativeCalculationSettings": {
- "$ref": "IterativeCalculationSettings",
- "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
- }
- },
- "id": "SpreadsheetProperties",
- "description": "Properties of a spreadsheet."
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
},
- "RepeatCellRequest": {
- "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.",
- "type": "object",
- "properties": {
- "range": {
- "$ref": "GridRange",
- "description": "The range to repeat the cell in."
- },
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "cell": {
- "description": "The data to write.",
- "$ref": "CellData"
- }
- },
- "id": "RepeatCellRequest"
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
},
- "AddChartResponse": {
- "id": "AddChartResponse",
- "description": "The result of adding a chart to a spreadsheet.",
- "type": "object",
- "properties": {
- "chart": {
- "$ref": "EmbeddedChart",
- "description": "The newly added chart."
- }
- }
+ "bearer_token": {
+ "description": "OAuth bearer token.",
+ "type": "string",
+ "location": "query"
},
- "InsertDimensionRequest": {
- "description": "Inserts rows or columns in a sheet at a particular index.",
- "type": "object",
- "properties": {
- "range": {
- "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
- "$ref": "DimensionRange"
- },
- "inheritFromBefore": {
- "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
- "type": "boolean"
- }
- },
- "id": "InsertDimensionRequest"
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
},
- "UpdateSpreadsheetPropertiesRequest": {
- "description": "Updates properties of a spreadsheet.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "properties": {
- "$ref": "SpreadsheetProperties",
- "description": "The properties to update."
- }
- },
- "id": "UpdateSpreadsheetPropertiesRequest"
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
},
- "ProtectedRange": {
- "description": "A protected range.",
- "type": "object",
- "properties": {
- "requestingUserCanEdit": {
- "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
- "type": "boolean"
- },
- "editors": {
- "$ref": "Editors",
- "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection."
- },
- "range": {
- "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.",
- "type": "array",
- "items": {
- "$ref": "GridRange"
- }
- },
- "namedRangeId": {
- "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "type": "string"
- },
- "protectedRangeId": {
- "description": "The ID of the protected range.\nThis field is read-only.",
- "format": "int32",
- "type": "integer"
- },
- "warningOnly": {
- "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
- "type": "boolean"
- }
- },
- "id": "ProtectedRange"
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
},
- "BatchUpdateValuesRequest": {
- "description": "The request for updating more than one range of values in a spreadsheet.",
- "type": "object",
- "properties": {
- "responseValueRenderOption": {
- "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string",
- "enumDescriptions": [
- "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
- "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
- "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
- ],
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ]
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
- "type": "boolean"
- },
- "valueInputOption": {
- "enumDescriptions": [
- "Default input value. This value must not be used.",
- "The values the user has entered will not be parsed and will be stored\nas-is.",
- "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
- ],
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "data": {
- "description": "The new values to apply to the spreadsheet.",
- "type": "array",
- "items": {
- "$ref": "ValueRange"
- }
- },
- "responseDateTimeRenderOption": {
- "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",
- "enumDescriptions": [
- "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nDays are counted from December 31st 1899 and are incremented by 1,\nand times are fractions of a day. For example, January 1st 1900 at noon\nwould be 1.5, 1 because it's 1 day offset from December 31st 1899,\nand .5 because noon is half a day. February 1st 1900 at 3pm would\nbe 32.625. This correctly treats the year 1900 as not 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)."
- ]
- }
- },
- "id": "BatchUpdateValuesRequest"
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
},
- "DimensionProperties": {
- "type": "object",
- "properties": {
- "pixelSize": {
- "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
- "format": "int32",
- "type": "integer"
- },
- "hiddenByFilter": {
- "description": "True if this dimension is being filtered.\nThis field is read-only.",
- "type": "boolean"
- },
- "hiddenByUser": {
- "description": "True if this dimension is explicitly hidden.",
- "type": "boolean"
- }
- },
- "id": "DimensionProperties",
- "description": "Properties about a dimension."
+ "$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string"
},
- "DimensionRange": {
- "properties": {
- "dimension": {
- "description": "The dimension of the span.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ]
- },
- "startIndex": {
- "description": "The start (inclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "description": "The end (exclusive) of the span, or not set if unbounded.",
- "format": "int32",
- "type": "integer"
- },
- "sheetId": {
- "description": "The sheet this span is on.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "DimensionRange",
- "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
- "type": "object"
- },
- "NamedRange": {
- "id": "NamedRange",
- "description": "A named range.",
- "type": "object",
- "properties": {
- "name": {
- "description": "The name of the named range.",
- "type": "string"
- },
- "namedRangeId": {
- "description": "The ID of the named range.",
- "type": "string"
- },
- "range": {
- "description": "The range this represents.",
- "$ref": "GridRange"
- }
- }
- },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v4",
+ "baseUrl": "https://sheets.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Reads and writes Google Sheets.",
+ "servicePath": "",
+ "basePath": "",
+ "id": "sheets:v4",
+ "revision": "20170303",
+ "documentationLink": "https://developers.google.com/sheets/",
+ "discoveryVersion": "v1",
+ "version_module": "True",
+ "schemas": {
"CutPasteRequest": {
"description": "Moves data from the source to the destination.",
"type": "object",
@@ -819,15 +609,6 @@
"description": "The source data to cut."
},
"pasteType": {
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
"enum": [
"PASTE_NORMAL",
"PASTE_VALUES",
@@ -838,7 +619,16 @@
"PASTE_CONDITIONAL_FORMATTING"
],
"description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ]
},
"destination": {
"description": "The top-left coordinate where the data should be pasted.",
@@ -848,12 +638,10 @@
"id": "CutPasteRequest"
},
"BasicChartSeries": {
- "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
- "type": "object",
"properties": {
"series": {
- "description": "The data being visualized in this chart series.",
- "$ref": "ChartData"
+ "$ref": "ChartData",
+ "description": "The data being visualized in this chart series."
},
"type": {
"enumDescriptions": [
@@ -878,6 +666,12 @@
"type": "string"
},
"targetAxis": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
"description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.",
"type": "string",
"enumDescriptions": [
@@ -885,21 +679,25 @@
"The axis rendered at the bottom of a chart.\nFor most charts, this is the standard major axis.\nFor bar charts, this is a minor axis.",
"The axis rendered at the left of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is the standard major axis.",
"The axis rendered at the right of a chart.\nFor most charts, this is a minor axis.\nFor bar charts, this is an unusual major axis."
- ],
- "enum": [
- "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
- "BOTTOM_AXIS",
- "LEFT_AXIS",
- "RIGHT_AXIS"
]
}
},
- "id": "BasicChartSeries"
+ "id": "BasicChartSeries",
+ "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".",
+ "type": "object"
},
"Borders": {
"description": "The borders of the cell.",
"type": "object",
"properties": {
+ "right": {
+ "description": "The right border of the cell.",
+ "$ref": "Border"
+ },
+ "bottom": {
+ "description": "The bottom border of the cell.",
+ "$ref": "Border"
+ },
"top": {
"$ref": "Border",
"description": "The top border of the cell."
@@ -907,34 +705,37 @@
"left": {
"$ref": "Border",
"description": "The left border of the cell."
- },
- "right": {
- "$ref": "Border",
- "description": "The right border of the cell."
- },
- "bottom": {
- "description": "The bottom border of the cell.",
- "$ref": "Border"
}
},
"id": "Borders"
},
"AutoResizeDimensionsRequest": {
- "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
- "type": "object",
"properties": {
"dimensions": {
- "$ref": "DimensionRange",
- "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported."
+ "description": "The dimensions to automatically resize.\nOnly COLUMNS are supported.",
+ "$ref": "DimensionRange"
}
},
- "id": "AutoResizeDimensionsRequest"
+ "id": "AutoResizeDimensionsRequest",
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "type": "object"
},
"UpdateBordersRequest": {
- "id": "UpdateBordersRequest",
"description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.",
"type": "object",
"properties": {
+ "bottom": {
+ "description": "The border to put at the bottom of the range.",
+ "$ref": "Border"
+ },
+ "innerVertical": {
+ "description": "The vertical border to put within the range.",
+ "$ref": "Border"
+ },
+ "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"
@@ -948,51 +749,16 @@
"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."
- },
- "innerVertical": {
- "$ref": "Border",
- "description": "The vertical border to put within the range."
- },
- "right": {
- "$ref": "Border",
- "description": "The border to put at the right of the range."
+ "description": "The border to put at the left of the range.",
+ "$ref": "Border"
}
- }
+ },
+ "id": "UpdateBordersRequest"
},
"CellFormat": {
+ "description": "The format of a cell.",
+ "type": "object",
"properties": {
- "textRotation": {
- "$ref": "TextRotation",
- "description": "The rotation applied to text in a cell"
- },
- "wrapStrategy": {
- "description": "The wrap strategy for the value in the cell.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
- "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
- "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
- "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
- ],
- "enum": [
- "WRAP_STRATEGY_UNSPECIFIED",
- "OVERFLOW_CELL",
- "LEGACY_WRAP",
- "CLIP",
- "WRAP"
- ]
- },
- "numberFormat": {
- "$ref": "NumberFormat",
- "description": "A format describing how number values should be represented to the user."
- },
"horizontalAlignment": {
"enumDescriptions": [
"The horizontal alignment is not specified. Do not use this.",
@@ -1010,8 +776,6 @@
"type": "string"
},
"hyperlinkDisplayType": {
- "description": "How a hyperlink, if it exists, should be displayed in the cell.",
- "type": "string",
"enumDescriptions": [
"The default value: the hyperlink is rendered. Do not use this.",
"A hyperlink should be explicitly rendered.",
@@ -1021,19 +785,17 @@
"HYPERLINK_DISPLAY_TYPE_UNSPECIFIED",
"LINKED",
"PLAIN_TEXT"
- ]
+ ],
+ "description": "How a hyperlink, if it exists, should be displayed in the cell.",
+ "type": "string"
},
"textFormat": {
- "description": "The format of the text in the cell (unless overridden by a format run).",
- "$ref": "TextFormat"
+ "$ref": "TextFormat",
+ "description": "The format of the text in the cell (unless overridden by a format run)."
},
"backgroundColor": {
- "$ref": "Color",
- "description": "The background color of the cell."
- },
- "padding": {
- "$ref": "Padding",
- "description": "The padding of the cell."
+ "description": "The background color of the cell.",
+ "$ref": "Color"
},
"verticalAlignment": {
"enum": [
@@ -1051,8 +813,11 @@
"The text is explicitly aligned to the bottom of the cell."
]
},
+ "padding": {
+ "description": "The padding of the cell.",
+ "$ref": "Padding"
+ },
"textDirection": {
- "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.",
@@ -1063,20 +828,43 @@
"LEFT_TO_RIGHT",
"RIGHT_TO_LEFT"
],
- "description": "The direction of the text in the cell."
+ "description": "The direction of the text in the cell.",
+ "type": "string"
},
"borders": {
- "$ref": "Borders",
- "description": "The borders of the cell."
+ "description": "The borders of the cell.",
+ "$ref": "Borders"
+ },
+ "textRotation": {
+ "$ref": "TextRotation",
+ "description": "The rotation applied to text in a cell"
+ },
+ "wrapStrategy": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |",
+ "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |",
+ "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |",
+ "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |"
+ ],
+ "enum": [
+ "WRAP_STRATEGY_UNSPECIFIED",
+ "OVERFLOW_CELL",
+ "LEGACY_WRAP",
+ "CLIP",
+ "WRAP"
+ ],
+ "description": "The wrap strategy for the value in the cell.",
+ "type": "string"
+ },
+ "numberFormat": {
+ "description": "A format describing how number values should be represented to the user.",
+ "$ref": "NumberFormat"
}
},
- "id": "CellFormat",
- "description": "The format of a cell.",
- "type": "object"
+ "id": "CellFormat"
},
"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.",
@@ -1087,11 +875,11 @@
"type": "string"
}
},
- "id": "ClearValuesResponse"
+ "id": "ClearValuesResponse",
+ "description": "The response when clearing a range of values in a spreadsheet.",
+ "type": "object"
},
"DeleteConditionalFormatRuleRequest": {
- "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
- "type": "object",
"properties": {
"index": {
"description": "The zero-based index of the rule to be deleted.",
@@ -1104,7 +892,20 @@
"type": "integer"
}
},
- "id": "DeleteConditionalFormatRuleRequest"
+ "id": "DeleteConditionalFormatRuleRequest",
+ "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.",
+ "type": "object"
+ },
+ "AddBandingResponse": {
+ "properties": {
+ "bandedRange": {
+ "description": "The banded range that was added.",
+ "$ref": "BandedRange"
+ }
+ },
+ "id": "AddBandingResponse",
+ "description": "The result of adding a banded range.",
+ "type": "object"
},
"DeleteNamedRangeRequest": {
"properties": {
@@ -1117,66 +918,52 @@
"description": "Removes the named range with the given ID from the spreadsheet.",
"type": "object"
},
- "AddBandingResponse": {
- "description": "The result of adding a banded range.",
- "type": "object",
- "properties": {
- "bandedRange": {
- "$ref": "BandedRange",
- "description": "The banded range that was added."
- }
- },
- "id": "AddBandingResponse"
- },
"ChartData": {
- "description": "The data included in a domain or series.",
- "type": "object",
"properties": {
"sourceRange": {
"$ref": "ChartSourceRange",
"description": "The source ranges of the data."
}
},
- "id": "ChartData"
+ "id": "ChartData",
+ "description": "The data included in a domain or series.",
+ "type": "object"
},
"BatchGetValuesResponse": {
"description": "The response when retrieving more than one range of values in a spreadsheet.",
"type": "object",
"properties": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet the data was retrieved from.",
- "type": "string"
- },
"valueRanges": {
"description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.",
"type": "array",
"items": {
"$ref": "ValueRange"
}
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet the data was retrieved from.",
+ "type": "string"
}
},
"id": "BatchGetValuesResponse"
},
"UpdateBandingRequest": {
+ "description": "Updates properties of the supplied banded range.",
+ "type": "object",
"properties": {
"fields": {
- "type": "string",
"description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"bandedRange": {
- "description": "The banded range to update with the new properties.",
- "$ref": "BandedRange"
+ "$ref": "BandedRange",
+ "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": {
- "id": "Color",
- "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...",
- "type": "object",
"properties": {
"red": {
"description": "The amount of red in the color as a value in the interval [0, 1].",
@@ -1198,20 +985,17 @@
"format": "float",
"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"
},
"PivotGroup": {
- "description": "A single grouping (either row or column) in a pivot table.",
- "type": "object",
"properties": {
- "valueBucket": {
- "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values.",
- "$ref": "PivotGroupSortValueBucket"
- },
"sourceColumnOffset": {
- "type": "integer",
"description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"showTotals": {
"description": "True if the pivot table should include the totals for this grouping.",
@@ -1225,37 +1009,61 @@
}
},
"sortOrder": {
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ],
"enum": [
"SORT_ORDER_UNSPECIFIED",
"ASCENDING",
"DESCENDING"
],
"description": "The order the values in this group should be sorted.",
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use this.",
- "Sort ascending.",
- "Sort descending."
- ]
+ "type": "string"
+ },
+ "valueBucket": {
+ "$ref": "PivotGroupSortValueBucket",
+ "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values."
}
},
- "id": "PivotGroup"
+ "id": "PivotGroup",
+ "description": "A single grouping (either row or column) in a pivot table.",
+ "type": "object"
},
"PivotTable": {
"description": "A pivot table.",
"type": "object",
"properties": {
+ "criteria": {
+ "additionalProperties": {
+ "$ref": "PivotFilterCriteria"
+ },
+ "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
+ "type": "object"
+ },
+ "rows": {
+ "description": "Each row grouping in the pivot table.",
+ "type": "array",
+ "items": {
+ "$ref": "PivotGroup"
+ }
+ },
"valueLayout": {
+ "enumDescriptions": [
+ "Values are laid out horizontally (as columns).",
+ "Values are laid out vertically (as rows)."
+ ],
"enum": [
"HORIZONTAL",
"VERTICAL"
],
"description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).",
- "type": "string",
- "enumDescriptions": [
- "Values are laid out horizontally (as columns).",
- "Values are laid out vertically (as rows)."
- ]
+ "type": "string"
+ },
+ "source": {
+ "description": "The range the pivot table is reading data from.",
+ "$ref": "GridRange"
},
"columns": {
"description": "Each column grouping in the pivot table.",
@@ -1270,31 +1078,11 @@
"items": {
"$ref": "PivotValue"
}
- },
- "source": {
- "$ref": "GridRange",
- "description": "The range the pivot table is reading data from."
- },
- "criteria": {
- "additionalProperties": {
- "$ref": "PivotFilterCriteria"
- },
- "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.",
- "type": "object"
- },
- "rows": {
- "description": "Each row grouping in the pivot table.",
- "type": "array",
- "items": {
- "$ref": "PivotGroup"
- }
}
},
"id": "PivotTable"
},
"ChartSourceRange": {
- "description": "Source ranges for a chart.",
- "type": "object",
"properties": {
"sources": {
"description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12",
@@ -1304,12 +1092,11 @@
}
}
},
- "id": "ChartSourceRange"
+ "id": "ChartSourceRange",
+ "description": "Source ranges for a chart.",
+ "type": "object"
},
"AppendCellsRequest": {
- "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",
"properties": {
"rows": {
"description": "The data to append.",
@@ -1319,34 +1106,41 @@
}
},
"fields": {
- "type": "string",
"description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"sheetId": {
- "type": "integer",
"description": "The sheet ID to append the data to.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "AppendCellsRequest",
+ "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.",
+ "type": "object"
},
"ValueRange": {
"description": "Data within a range of the spreadsheet.",
"type": "object",
"properties": {
+ "range": {
+ "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
+ "type": "string"
+ },
"majorDimension": {
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ],
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
"description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ]
},
"values": {
"description": "The data 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.",
@@ -1357,10 +1151,6 @@
"type": "any"
}
}
- },
- "range": {
- "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.",
- "type": "string"
}
},
"id": "ValueRange"
@@ -1370,8 +1160,8 @@
"type": "object",
"properties": {
"bandedRange": {
- "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)",
- "$ref": "BandedRange"
+ "$ref": "BandedRange",
+ "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)"
}
},
"id": "AddBandingRequest"
@@ -1380,10 +1170,6 @@
"description": "A single response from an update.",
"type": "object",
"properties": {
- "findReplace": {
- "description": "A reply from doing a find/replace.",
- "$ref": "FindReplaceResponse"
- },
"addSheet": {
"description": "A reply from adding a sheet.",
"$ref": "AddSheetResponse"
@@ -1401,39 +1187,41 @@
"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": {
"$ref": "AddProtectedRangeResponse",
"description": "A reply from adding a protected range."
},
"duplicateSheet": {
- "$ref": "DuplicateSheetResponse",
- "description": "A reply from duplicating a sheet."
- },
- "updateEmbeddedObjectPosition": {
- "description": "A reply from updating an embedded object's position.",
- "$ref": "UpdateEmbeddedObjectPositionResponse"
+ "description": "A reply from duplicating a sheet.",
+ "$ref": "DuplicateSheetResponse"
},
"deleteConditionalFormatRule": {
"$ref": "DeleteConditionalFormatRuleResponse",
"description": "A reply from deleting a conditional format rule."
},
+ "updateEmbeddedObjectPosition": {
+ "$ref": "UpdateEmbeddedObjectPositionResponse",
+ "description": "A reply from updating an embedded object's position."
+ },
"duplicateFilterView": {
"$ref": "DuplicateFilterViewResponse",
"description": "A reply from duplicating a filter view."
},
"addChart": {
- "$ref": "AddChartResponse",
- "description": "A reply from adding a chart."
+ "description": "A reply from adding a chart.",
+ "$ref": "AddChartResponse"
+ },
+ "findReplace": {
+ "description": "A reply from doing a find/replace.",
+ "$ref": "FindReplaceResponse"
}
},
"id": "Response"
},
"EmbeddedChart": {
- "description": "A chart embedded in a sheet.",
- "type": "object",
"properties": {
"chartId": {
"description": "The ID of the chart.",
@@ -1449,54 +1237,56 @@
"$ref": "ChartSpec"
}
},
- "id": "EmbeddedChart"
- },
- "TextFormatRun": {
- "properties": {
- "format": {
- "$ref": "TextFormat",
- "description": "The format of this run. Absent values inherit the cell's format."
- },
- "startIndex": {
- "description": "The character index where this run starts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "TextFormatRun",
- "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": "EmbeddedChart",
+ "description": "A chart embedded in a sheet.",
"type": "object"
},
"InsertRangeRequest": {
- "description": "Inserts cells into a range, shifting the existing cells over or down.",
- "type": "object",
"properties": {
"shiftDimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
"enum": [
"DIMENSION_UNSPECIFIED",
"ROWS",
"COLUMNS"
],
"description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.",
- "type": "string",
- "enumDescriptions": [
- "The default value, do not use.",
- "Operates on the rows of a sheet.",
- "Operates on the columns of a sheet."
- ]
+ "type": "string"
},
"range": {
"$ref": "GridRange",
"description": "The range to insert new cells into."
}
},
- "id": "InsertRangeRequest"
+ "id": "InsertRangeRequest",
+ "description": "Inserts cells into a range, shifting the existing cells over or down.",
+ "type": "object"
+ },
+ "TextFormatRun": {
+ "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.",
+ "type": "object",
+ "properties": {
+ "startIndex": {
+ "description": "The character index where this run starts.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "format": {
+ "$ref": "TextFormat",
+ "description": "The format of this run. Absent values inherit the cell's format."
+ }
+ },
+ "id": "TextFormatRun"
},
"AddNamedRangeResponse": {
"properties": {
"namedRange": {
- "$ref": "NamedRange",
- "description": "The named range to add."
+ "description": "The named range to add.",
+ "$ref": "NamedRange"
}
},
"id": "AddNamedRangeResponse",
@@ -1517,10 +1307,53 @@
},
"id": "RowData"
},
+ "GridData": {
+ "properties": {
+ "columnMetadata": {
+ "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "startColumn": {
+ "description": "The first column this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowMetadata": {
+ "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
+ "type": "array",
+ "items": {
+ "$ref": "DimensionProperties"
+ }
+ },
+ "rowData": {
+ "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
+ "type": "array",
+ "items": {
+ "$ref": "RowData"
+ }
+ },
+ "startRow": {
+ "description": "The first row this GridData refers to, zero-based.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "GridData",
+ "description": "Data in the grid, as well as metadata about the dimensions.",
+ "type": "object"
+ },
"Border": {
"description": "A border along a cell.",
"type": "object",
"properties": {
+ "width": {
+ "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
+ "format": "int32",
+ "type": "integer"
+ },
"style": {
"enum": [
"STYLE_UNSPECIFIED",
@@ -1546,102 +1379,13 @@
]
},
"color": {
- "$ref": "Color",
- "description": "The color of the border."
- },
- "width": {
- "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.",
- "format": "int32",
- "type": "integer"
+ "description": "The color of the border.",
+ "$ref": "Color"
}
},
"id": "Border"
},
- "GridData": {
- "description": "Data in the grid, as well as metadata about the dimensions.",
- "type": "object",
- "properties": {
- "rowData": {
- "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.",
- "type": "array",
- "items": {
- "$ref": "RowData"
- }
- },
- "startRow": {
- "type": "integer",
- "description": "The first row this GridData refers to, zero-based.",
- "format": "int32"
- },
- "columnMetadata": {
- "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- },
- "startColumn": {
- "type": "integer",
- "description": "The first column this GridData refers to, zero-based.",
- "format": "int32"
- },
- "rowMetadata": {
- "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.",
- "type": "array",
- "items": {
- "$ref": "DimensionProperties"
- }
- }
- },
- "id": "GridData"
- },
- "FindReplaceRequest": {
- "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
- "type": "object",
- "properties": {
- "includeFormulas": {
- "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
- "type": "boolean"
- },
- "matchEntireCell": {
- "description": "True if the find value should match the entire cell.",
- "type": "boolean"
- },
- "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": {
- "type": "string",
- "description": "The value to use as the replacement."
- },
- "range": {
- "description": "The range to find/replace over.",
- "$ref": "GridRange"
- },
- "sheetId": {
- "description": "The sheet to find/replace over.",
- "format": "int32",
- "type": "integer"
- },
- "matchCase": {
- "description": "True if the search is case sensitive.",
- "type": "boolean"
- },
- "allSheets": {
- "description": "True to find/replace over all sheets.",
- "type": "boolean"
- }
- },
- "id": "FindReplaceRequest"
- },
"UpdateNamedRangeRequest": {
- "description": "Updates properties of the named range with the specified\nnamedRangeId.",
- "type": "object",
"properties": {
"namedRange": {
"description": "The named range to update with the new properties.",
@@ -1653,59 +1397,104 @@
"type": "string"
}
},
- "id": "UpdateNamedRangeRequest"
+ "id": "UpdateNamedRangeRequest",
+ "description": "Updates properties of the named range with the specified\nnamedRangeId.",
+ "type": "object"
+ },
+ "FindReplaceRequest": {
+ "properties": {
+ "sheetId": {
+ "description": "The sheet to find/replace over.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "allSheets": {
+ "description": "True to find/replace over all sheets.",
+ "type": "boolean"
+ },
+ "matchCase": {
+ "description": "True if the search is case sensitive.",
+ "type": "boolean"
+ },
+ "includeFormulas": {
+ "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.",
+ "type": "boolean"
+ },
+ "matchEntireCell": {
+ "description": "True if the find value should match the entire cell.",
+ "type": "boolean"
+ },
+ "searchByRegex": {
+ "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.",
+ "type": "boolean"
+ },
+ "find": {
+ "description": "The value to search.",
+ "type": "string"
+ },
+ "replacement": {
+ "description": "The value to use as the replacement.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range to find/replace over.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "FindReplaceRequest",
+ "description": "Finds and replaces data in cells over a range, sheet, or all sheets.",
+ "type": "object"
},
"AddSheetRequest": {
- "id": "AddSheetRequest",
"description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.",
"type": "object",
"properties": {
"properties": {
- "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)",
- "$ref": "SheetProperties"
+ "$ref": "SheetProperties",
+ "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)"
}
- }
+ },
+ "id": "AddSheetRequest"
},
"UpdateCellsRequest": {
"description": "Updates all cells in a range with new data.",
"type": "object",
"properties": {
+ "start": {
+ "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
+ "$ref": "GridCoordinate"
+ },
"range": {
- "$ref": "GridRange",
- "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared."
+ "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"
},
"rows": {
+ "description": "The data to write.",
"type": "array",
"items": {
"$ref": "RowData"
- },
- "description": "The data to write."
+ }
},
"fields": {
"description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"format": "google-fieldmask",
"type": "string"
- },
- "start": {
- "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.",
- "$ref": "GridCoordinate"
}
},
"id": "UpdateCellsRequest"
},
"DeleteConditionalFormatRuleResponse": {
- "description": "The result of deleting a conditional format rule.",
- "type": "object",
"properties": {
"rule": {
"$ref": "ConditionalFormatRule",
"description": "The rule that was deleted."
}
},
- "id": "DeleteConditionalFormatRuleResponse"
+ "id": "DeleteConditionalFormatRuleResponse",
+ "description": "The result of deleting a conditional format rule.",
+ "type": "object"
},
"DeleteRangeRequest": {
- "type": "object",
"properties": {
"shiftDimension": {
"enumDescriptions": [
@@ -1727,12 +1516,18 @@
}
},
"id": "DeleteRangeRequest",
- "description": "Deletes a range of cells, shifting other cells into the deleted area."
+ "description": "Deletes a range of cells, shifting other cells into the deleted area.",
+ "type": "object"
},
"GridCoordinate": {
"description": "A coordinate in a sheet.\nAll indexes are zero-based.",
"type": "object",
"properties": {
+ "sheetId": {
+ "description": "The sheet this coordinate is on.",
+ "format": "int32",
+ "type": "integer"
+ },
"rowIndex": {
"description": "The row index of the coordinate.",
"format": "int32",
@@ -1742,11 +1537,6 @@
"description": "The column index of the coordinate.",
"format": "int32",
"type": "integer"
- },
- "sheetId": {
- "description": "The sheet this coordinate is on.",
- "format": "int32",
- "type": "integer"
}
},
"id": "GridCoordinate"
@@ -1756,20 +1546,26 @@
"type": "object",
"properties": {
"fields": {
- "type": "string",
"description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask"
+ "format": "google-fieldmask",
+ "type": "string"
},
"properties": {
- "description": "The properties to update.",
- "$ref": "SheetProperties"
+ "$ref": "SheetProperties",
+ "description": "The properties to update."
}
},
"id": "UpdateSheetPropertiesRequest"
},
"GridProperties": {
+ "description": "Properties of a grid.",
"type": "object",
"properties": {
+ "rowCount": {
+ "description": "The number of rows in the grid.",
+ "format": "int32",
+ "type": "integer"
+ },
"frozenRowCount": {
"description": "The number of rows that are frozen in the grid.",
"format": "int32",
@@ -1785,74 +1581,80 @@
"type": "integer"
},
"frozenColumnCount": {
- "type": "integer",
"description": "The number of columns that are frozen in the grid.",
- "format": "int32"
- },
- "rowCount": {
- "description": "The number of rows in the grid.",
"format": "int32",
"type": "integer"
}
},
- "id": "GridProperties",
- "description": "Properties of a grid."
+ "id": "GridProperties"
},
"UnmergeCellsRequest": {
- "description": "Unmerges cells in the given range.",
- "type": "object",
"properties": {
"range": {
- "$ref": "GridRange",
- "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge."
+ "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.",
+ "$ref": "GridRange"
}
},
- "id": "UnmergeCellsRequest"
+ "id": "UnmergeCellsRequest",
+ "description": "Unmerges cells in the given range.",
+ "type": "object"
},
"UpdateEmbeddedObjectPositionResponse": {
- "description": "The result of updating an embedded object's position.",
- "type": "object",
"properties": {
"position": {
"$ref": "EmbeddedObjectPosition",
"description": "The new position of the embedded object."
}
},
- "id": "UpdateEmbeddedObjectPositionResponse"
+ "id": "UpdateEmbeddedObjectPositionResponse",
+ "description": "The result of updating an embedded object's position.",
+ "type": "object"
},
"SortSpec": {
+ "description": "A sort order associated with a specific column or row.",
"type": "object",
"properties": {
- "dimensionIndex": {
- "description": "The dimension the sort should be applied to.",
- "format": "int32",
- "type": "integer"
- },
"sortOrder": {
- "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"
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use this.",
+ "Sort ascending.",
+ "Sort descending."
+ ]
+ },
+ "dimensionIndex": {
+ "description": "The dimension the sort should be applied to.",
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "SortSpec",
- "description": "A sort order associated with a specific column or row."
+ "id": "SortSpec"
},
"Sheet": {
- "description": "A sheet in a spreadsheet.",
- "type": "object",
"properties": {
+ "protectedRanges": {
+ "description": "The protected ranges in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ProtectedRange"
+ }
+ },
+ "conditionalFormats": {
+ "description": "The conditional format rules in this sheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ConditionalFormatRule"
+ }
+ },
"basicFilter": {
- "$ref": "BasicFilter",
- "description": "The filter on this sheet, if any."
+ "description": "The filter on this sheet, if any.",
+ "$ref": "BasicFilter"
},
"merges": {
"description": "The ranges that are merged together.",
@@ -1862,11 +1664,11 @@
}
},
"data": {
+ "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).",
"type": "array",
"items": {
"$ref": "GridData"
- },
- "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D)."
+ }
},
"bandedRanges": {
"description": "The banded (i.e. alternating colors) ranges on this sheet.",
@@ -1883,8 +1685,8 @@
}
},
"properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the sheet."
+ "description": "The properties of the sheet.",
+ "$ref": "SheetProperties"
},
"filterViews": {
"description": "The filter views in this sheet.",
@@ -1892,35 +1694,23 @@
"items": {
"$ref": "FilterView"
}
- },
- "protectedRanges": {
- "type": "array",
- "items": {
- "$ref": "ProtectedRange"
- },
- "description": "The protected ranges in this sheet."
- },
- "conditionalFormats": {
- "description": "The conditional format rules in this sheet.",
- "type": "array",
- "items": {
- "$ref": "ConditionalFormatRule"
- }
}
},
- "id": "Sheet"
+ "id": "Sheet",
+ "description": "A sheet in a spreadsheet.",
+ "type": "object"
},
"BooleanRule": {
"description": "A rule that may or may not match, depending on the condition.",
"type": "object",
"properties": {
- "format": {
- "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color.",
- "$ref": "CellFormat"
- },
"condition": {
"$ref": "BooleanCondition",
"description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied."
+ },
+ "format": {
+ "$ref": "CellFormat",
+ "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color."
}
},
"id": "BooleanRule"
@@ -1959,6 +1749,8 @@
"id": "FilterCriteria"
},
"Editors": {
+ "description": "The editors of a protected range.",
+ "type": "object",
"properties": {
"users": {
"description": "The email addresses of users with edit access to the protected range.",
@@ -1979,14 +1771,9 @@
"type": "boolean"
}
},
- "id": "Editors",
- "description": "The editors of a protected range.",
- "type": "object"
+ "id": "Editors"
},
"UpdateConditionalFormatRuleRequest": {
- "id": "UpdateConditionalFormatRuleRequest",
- "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
- "type": "object",
"properties": {
"rule": {
"$ref": "ConditionalFormatRule",
@@ -2007,18 +1794,13 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.",
+ "type": "object"
},
"DataValidationRule": {
"properties": {
- "condition": {
- "description": "The condition that data in the cell must match.",
- "$ref": "BooleanCondition"
- },
- "showCustomUi": {
- "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.",
- "type": "boolean"
- },
"strict": {
"description": "True if invalid data should be rejected.",
"type": "boolean"
@@ -2026,6 +1808,14 @@
"inputMessage": {
"description": "A message to show the user when adding data to the cell.",
"type": "string"
+ },
+ "condition": {
+ "$ref": "BooleanCondition",
+ "description": "The condition that data in the cell must match."
+ },
+ "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"
}
},
"id": "DataValidationRule",
@@ -2033,24 +1823,35 @@
"type": "object"
},
"BasicChartDomain": {
- "properties": {
- "domain": {
- "$ref": "ChartData",
- "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates."
- }
- },
- "id": "BasicChartDomain",
"description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.",
- "type": "object"
- },
- "PasteDataRequest": {
- "id": "PasteDataRequest",
- "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
"type": "object",
"properties": {
+ "domain": {
+ "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates.",
+ "$ref": "ChartData"
+ }
+ },
+ "id": "BasicChartDomain"
+ },
+ "PasteDataRequest": {
+ "properties": {
+ "html": {
+ "description": "True if the data is HTML.",
+ "type": "boolean"
+ },
+ "coordinate": {
+ "description": "The coordinate at which the data should start being inserted.",
+ "$ref": "GridCoordinate"
+ },
+ "data": {
+ "description": "The data to insert.",
+ "type": "string"
+ },
+ "delimiter": {
+ "description": "The delimiter in the data.",
+ "type": "string"
+ },
"type": {
- "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.",
@@ -2068,56 +1869,45 @@
"PASTE_FORMULA",
"PASTE_DATA_VALIDATION",
"PASTE_CONDITIONAL_FORMATTING"
- ]
- },
- "html": {
- "description": "True if the data is HTML.",
- "type": "boolean"
- },
- "coordinate": {
- "description": "The coordinate at which the data should start being inserted.",
- "$ref": "GridCoordinate"
- },
- "data": {
- "description": "The data to insert.",
- "type": "string"
- },
- "delimiter": {
- "description": "The delimiter in the data.",
+ ],
+ "description": "How the data should be pasted.",
"type": "string"
}
- }
+ },
+ "id": "PasteDataRequest",
+ "description": "Inserts data into the spreadsheet starting at the specified coordinate.",
+ "type": "object"
},
"AppendDimensionRequest": {
- "id": "AppendDimensionRequest",
"description": "Appends rows or columns to the end of a sheet.",
"type": "object",
"properties": {
- "sheetId": {
- "description": "The sheet to append rows or columns to.",
- "format": "int32",
- "type": "integer"
- },
"dimension": {
+ "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": {
"description": "The number of rows or columns to append.",
"format": "int32",
"type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet to append rows or columns to.",
+ "format": "int32",
+ "type": "integer"
}
- }
+ },
+ "id": "AppendDimensionRequest"
},
"AddNamedRangeRequest": {
"description": "Adds a named range to the spreadsheet.",
@@ -2131,25 +1921,25 @@
"id": "AddNamedRangeRequest"
},
"UpdateEmbeddedObjectPositionRequest": {
- "id": "UpdateEmbeddedObjectPositionRequest",
- "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
- "type": "object",
"properties": {
+ "fields": {
+ "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
"objectId": {
"description": "The ID of the object to moved.",
"format": "int32",
"type": "integer"
},
"newPosition": {
- "$ref": "EmbeddedObjectPosition",
- "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you."
- },
- "fields": {
- "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
- "format": "google-fieldmask",
- "type": "string"
+ "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"
}
- }
+ },
+ "id": "UpdateEmbeddedObjectPositionRequest",
+ "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).",
+ "type": "object"
},
"TextRotation": {
"description": "The rotation applied to text in a cell.",
@@ -2168,8 +1958,6 @@
"id": "TextRotation"
},
"PieChartSpec": {
- "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
- "type": "object",
"properties": {
"domain": {
"$ref": "ChartData",
@@ -2184,16 +1972,6 @@
"description": "The data that covers the one and only series of the pie chart."
},
"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",
@@ -2203,7 +1981,17 @@
"NO_LEGEND",
"LABELED_LEGEND"
],
- "description": "Where the legend of the pie chart should be drawn."
+ "description": "Where the legend of the pie chart should be drawn.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered.",
+ "Each pie slice has a label attached to it."
+ ]
},
"pieHole": {
"description": "The size of the hole in the pie chart.",
@@ -2211,9 +1999,12 @@
"type": "number"
}
},
- "id": "PieChartSpec"
+ "id": "PieChartSpec",
+ "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.",
+ "type": "object"
},
"UpdateFilterViewRequest": {
+ "description": "Updates properties of the filter view.",
"type": "object",
"properties": {
"fields": {
@@ -2226,8 +2017,7 @@
"description": "The new properties of the filter view."
}
},
- "id": "UpdateFilterViewRequest",
- "description": "Updates properties of the filter view."
+ "id": "UpdateFilterViewRequest"
},
"ConditionalFormatRule": {
"description": "A rule describing a conditional format.",
@@ -2241,23 +2031,21 @@
}
},
"gradientRule": {
- "description": "The formatting will vary based on the gradients in the rule.",
- "$ref": "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"
}
},
"id": "ConditionalFormatRule"
},
"CopyPasteRequest": {
- "description": "Copies data from the source to the destination.",
- "type": "object",
"properties": {
"destination": {
- "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).",
- "$ref": "GridRange"
+ "$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": [
@@ -2276,15 +2064,6 @@
"description": "The source range to copy."
},
"pasteType": {
- "enumDescriptions": [
- "Paste values, formulas, formats, and merges.",
- "Paste the values ONLY without formats, formulas, or merges.",
- "Paste the format and data validation only.",
- "Like PASTE_NORMAL but without borders.",
- "Paste the formulas only.",
- "Paste the data validation only.",
- "Paste the conditional formatting rules only."
- ],
"enum": [
"PASTE_NORMAL",
"PASTE_VALUES",
@@ -2295,10 +2074,224 @@
"PASTE_CONDITIONAL_FORMATTING"
],
"description": "What kind of data to paste.",
- "type": "string"
+ "type": "string",
+ "enumDescriptions": [
+ "Paste values, formulas, formats, and merges.",
+ "Paste the values ONLY without formats, formulas, or merges.",
+ "Paste the format and data validation only.",
+ "Like PASTE_NORMAL but without borders.",
+ "Paste the formulas only.",
+ "Paste the data validation only.",
+ "Paste the conditional formatting rules only."
+ ]
}
},
- "id": "CopyPasteRequest"
+ "id": "CopyPasteRequest",
+ "description": "Copies data from the source to the destination.",
+ "type": "object"
+ },
+ "Request": {
+ "properties": {
+ "repeatCell": {
+ "$ref": "RepeatCellRequest",
+ "description": "Repeats a single cell across a range."
+ },
+ "clearBasicFilter": {
+ "$ref": "ClearBasicFilterRequest",
+ "description": "Clears the basic filter on a sheet."
+ },
+ "appendDimension": {
+ "$ref": "AppendDimensionRequest",
+ "description": "Appends dimensions to the end of a sheet."
+ },
+ "updateConditionalFormatRule": {
+ "$ref": "UpdateConditionalFormatRuleRequest",
+ "description": "Updates an existing conditional format rule."
+ },
+ "insertRange": {
+ "description": "Inserts new cells in a sheet, shifting the existing cells.",
+ "$ref": "InsertRangeRequest"
+ },
+ "moveDimension": {
+ "description": "Moves rows or columns to another location in a sheet.",
+ "$ref": "MoveDimensionRequest"
+ },
+ "updateBanding": {
+ "$ref": "UpdateBandingRequest",
+ "description": "Updates a banded range"
+ },
+ "addProtectedRange": {
+ "$ref": "AddProtectedRangeRequest",
+ "description": "Adds a protected range."
+ },
+ "deleteNamedRange": {
+ "$ref": "DeleteNamedRangeRequest",
+ "description": "Deletes a named range."
+ },
+ "duplicateSheet": {
+ "description": "Duplicates a sheet.",
+ "$ref": "DuplicateSheetRequest"
+ },
+ "unmergeCells": {
+ "description": "Unmerges merged cells.",
+ "$ref": "UnmergeCellsRequest"
+ },
+ "deleteSheet": {
+ "$ref": "DeleteSheetRequest",
+ "description": "Deletes a sheet."
+ },
+ "updateEmbeddedObjectPosition": {
+ "description": "Updates an embedded object's (e.g. chart, image) position.",
+ "$ref": "UpdateEmbeddedObjectPositionRequest"
+ },
+ "updateDimensionProperties": {
+ "description": "Updates dimensions' properties.",
+ "$ref": "UpdateDimensionPropertiesRequest"
+ },
+ "pasteData": {
+ "$ref": "PasteDataRequest",
+ "description": "Pastes data (HTML or delimited) into a sheet."
+ },
+ "setBasicFilter": {
+ "$ref": "SetBasicFilterRequest",
+ "description": "Sets the basic filter on a sheet."
+ },
+ "addConditionalFormatRule": {
+ "description": "Adds a new conditional format rule.",
+ "$ref": "AddConditionalFormatRuleRequest"
+ },
+ "updateCells": {
+ "description": "Updates many cells at once.",
+ "$ref": "UpdateCellsRequest"
+ },
+ "addNamedRange": {
+ "description": "Adds a named range.",
+ "$ref": "AddNamedRangeRequest"
+ },
+ "updateSpreadsheetProperties": {
+ "description": "Updates the spreadsheet's properties.",
+ "$ref": "UpdateSpreadsheetPropertiesRequest"
+ },
+ "deleteEmbeddedObject": {
+ "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
+ "$ref": "DeleteEmbeddedObjectRequest"
+ },
+ "updateFilterView": {
+ "$ref": "UpdateFilterViewRequest",
+ "description": "Updates the properties of a filter view."
+ },
+ "addBanding": {
+ "description": "Adds a new banded range",
+ "$ref": "AddBandingRequest"
+ },
+ "appendCells": {
+ "$ref": "AppendCellsRequest",
+ "description": "Appends cells after the last row with data in a sheet."
+ },
+ "autoResizeDimensions": {
+ "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.",
+ "$ref": "AutoResizeDimensionsRequest"
+ },
+ "cutPaste": {
+ "$ref": "CutPasteRequest",
+ "description": "Cuts data from one area and pastes it to another."
+ },
+ "mergeCells": {
+ "description": "Merges cells together.",
+ "$ref": "MergeCellsRequest"
+ },
+ "updateNamedRange": {
+ "$ref": "UpdateNamedRangeRequest",
+ "description": "Updates a named range."
+ },
+ "updateSheetProperties": {
+ "description": "Updates a sheet's properties.",
+ "$ref": "UpdateSheetPropertiesRequest"
+ },
+ "autoFill": {
+ "$ref": "AutoFillRequest",
+ "description": "Automatically fills in more data based on existing data."
+ },
+ "deleteDimension": {
+ "$ref": "DeleteDimensionRequest",
+ "description": "Deletes rows or columns in a sheet."
+ },
+ "sortRange": {
+ "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": {
+ "description": "Adds a chart.",
+ "$ref": "AddChartRequest"
+ },
+ "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": {
+ "description": "Updates a chart's specifications.",
+ "$ref": "UpdateChartSpecRequest"
+ },
+ "addSheet": {
+ "description": "Adds a sheet.",
+ "$ref": "AddSheetRequest"
+ },
+ "updateProtectedRange": {
+ "$ref": "UpdateProtectedRangeRequest",
+ "description": "Updates a protected range."
+ },
+ "deleteFilterView": {
+ "description": "Deletes a filter view from a sheet.",
+ "$ref": "DeleteFilterViewRequest"
+ },
+ "copyPaste": {
+ "description": "Copies data from one area and pastes it to another.",
+ "$ref": "CopyPasteRequest"
+ },
+ "insertDimension": {
+ "description": "Inserts new rows or columns in a sheet.",
+ "$ref": "InsertDimensionRequest"
+ },
+ "deleteRange": {
+ "$ref": "DeleteRangeRequest",
+ "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
+ },
+ "deleteBanding": {
+ "description": "Removes a banded range",
+ "$ref": "DeleteBandingRequest"
+ },
+ "addFilterView": {
+ "description": "Adds a filter view.",
+ "$ref": "AddFilterViewRequest"
+ },
+ "setDataValidation": {
+ "$ref": "SetDataValidationRequest",
+ "description": "Sets data validation for one or more cells."
+ },
+ "updateBorders": {
+ "description": "Updates the borders in a range of cells.",
+ "$ref": "UpdateBordersRequest"
+ },
+ "deleteConditionalFormatRule": {
+ "description": "Deletes an existing conditional format rule.",
+ "$ref": "DeleteConditionalFormatRuleRequest"
+ }
+ },
+ "id": "Request",
+ "description": "A single kind of update to apply to a spreadsheet.",
+ "type": "object"
},
"BooleanCondition": {
"description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.",
@@ -2380,211 +2373,7 @@
},
"id": "BooleanCondition"
},
- "Request": {
- "description": "A single kind of update to apply to a spreadsheet.",
- "type": "object",
- "properties": {
- "updateSheetProperties": {
- "description": "Updates a sheet's properties.",
- "$ref": "UpdateSheetPropertiesRequest"
- },
- "deleteDimension": {
- "$ref": "DeleteDimensionRequest",
- "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": {
- "description": "Adds a chart.",
- "$ref": "AddChartRequest"
- },
- "findReplace": {
- "$ref": "FindReplaceRequest",
- "description": "Finds and replaces occurrences of some text with other text."
- },
- "updateChartSpec": {
- "description": "Updates a chart's specifications.",
- "$ref": "UpdateChartSpecRequest"
- },
- "textToColumns": {
- "description": "Converts a column of text into many columns of text.",
- "$ref": "TextToColumnsRequest"
- },
- "updateProtectedRange": {
- "$ref": "UpdateProtectedRangeRequest",
- "description": "Updates a protected range."
- },
- "addSheet": {
- "description": "Adds a sheet.",
- "$ref": "AddSheetRequest"
- },
- "copyPaste": {
- "$ref": "CopyPasteRequest",
- "description": "Copies data from one area and pastes it to another."
- },
- "deleteFilterView": {
- "$ref": "DeleteFilterViewRequest",
- "description": "Deletes a filter view from a sheet."
- },
- "insertDimension": {
- "$ref": "InsertDimensionRequest",
- "description": "Inserts new rows or columns in a sheet."
- },
- "deleteRange": {
- "$ref": "DeleteRangeRequest",
- "description": "Deletes a range of cells from a sheet, shifting the remaining cells."
- },
- "deleteBanding": {
- "$ref": "DeleteBandingRequest",
- "description": "Removes a banded range"
- },
- "addFilterView": {
- "$ref": "AddFilterViewRequest",
- "description": "Adds a filter view."
- },
- "setDataValidation": {
- "$ref": "SetDataValidationRequest",
- "description": "Sets data validation for one or more cells."
- },
- "updateBorders": {
- "description": "Updates the borders in a range of cells.",
- "$ref": "UpdateBordersRequest"
- },
- "deleteConditionalFormatRule": {
- "description": "Deletes an existing conditional format rule.",
- "$ref": "DeleteConditionalFormatRuleRequest"
- },
- "repeatCell": {
- "$ref": "RepeatCellRequest",
- "description": "Repeats a single cell across a range."
- },
- "clearBasicFilter": {
- "description": "Clears the basic filter on a sheet.",
- "$ref": "ClearBasicFilterRequest"
- },
- "appendDimension": {
- "$ref": "AppendDimensionRequest",
- "description": "Appends dimensions to the end of a sheet."
- },
- "updateConditionalFormatRule": {
- "$ref": "UpdateConditionalFormatRuleRequest",
- "description": "Updates an existing conditional format rule."
- },
- "insertRange": {
- "description": "Inserts new cells in a sheet, shifting the existing cells.",
- "$ref": "InsertRangeRequest"
- },
- "moveDimension": {
- "description": "Moves rows or columns to another location in a sheet.",
- "$ref": "MoveDimensionRequest"
- },
- "updateBanding": {
- "$ref": "UpdateBandingRequest",
- "description": "Updates a banded range"
- },
- "deleteNamedRange": {
- "$ref": "DeleteNamedRangeRequest",
- "description": "Deletes a named range."
- },
- "addProtectedRange": {
- "$ref": "AddProtectedRangeRequest",
- "description": "Adds a protected range."
- },
- "duplicateSheet": {
- "description": "Duplicates a sheet.",
- "$ref": "DuplicateSheetRequest"
- },
- "deleteSheet": {
- "$ref": "DeleteSheetRequest",
- "description": "Deletes a sheet."
- },
- "unmergeCells": {
- "$ref": "UnmergeCellsRequest",
- "description": "Unmerges merged cells."
- },
- "updateEmbeddedObjectPosition": {
- "$ref": "UpdateEmbeddedObjectPositionRequest",
- "description": "Updates an embedded object's (e.g. chart, image) position."
- },
- "updateDimensionProperties": {
- "$ref": "UpdateDimensionPropertiesRequest",
- "description": "Updates dimensions' properties."
- },
- "pasteData": {
- "$ref": "PasteDataRequest",
- "description": "Pastes data (HTML or delimited) into a sheet."
- },
- "setBasicFilter": {
- "description": "Sets the basic filter on a sheet.",
- "$ref": "SetBasicFilterRequest"
- },
- "addConditionalFormatRule": {
- "description": "Adds a new conditional format rule.",
- "$ref": "AddConditionalFormatRuleRequest"
- },
- "updateCells": {
- "description": "Updates many cells at once.",
- "$ref": "UpdateCellsRequest"
- },
- "addNamedRange": {
- "description": "Adds a named range.",
- "$ref": "AddNamedRangeRequest"
- },
- "updateSpreadsheetProperties": {
- "description": "Updates the spreadsheet's properties.",
- "$ref": "UpdateSpreadsheetPropertiesRequest"
- },
- "deleteEmbeddedObject": {
- "description": "Deletes an embedded object (e.g, chart, image) in a sheet.",
- "$ref": "DeleteEmbeddedObjectRequest"
- },
- "updateFilterView": {
- "description": "Updates the properties of a filter view.",
- "$ref": "UpdateFilterViewRequest"
- },
- "addBanding": {
- "description": "Adds a new banded range",
- "$ref": "AddBandingRequest"
- },
- "appendCells": {
- "description": "Appends cells after the last row with data in a sheet.",
- "$ref": "AppendCellsRequest"
- },
- "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."
- },
- "mergeCells": {
- "$ref": "MergeCellsRequest",
- "description": "Merges cells together."
- },
- "updateNamedRange": {
- "description": "Updates a named range.",
- "$ref": "UpdateNamedRangeRequest"
- }
- },
- "id": "Request"
- },
"GridRange": {
- "id": "GridRange",
"description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.",
"type": "object",
"properties": {
@@ -2599,9 +2388,9 @@
"type": "integer"
},
"endRowIndex": {
- "type": "integer",
"description": "The end row (exclusive) of the range, or not set if unbounded.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"endColumnIndex": {
"description": "The end column (exclusive) of the range, or not set if unbounded.",
@@ -2613,12 +2402,33 @@
"format": "int32",
"type": "integer"
}
- }
+ },
+ "id": "GridRange"
},
"BasicChartSpec": {
"description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.",
"type": "object",
"properties": {
+ "legendPosition": {
+ "enum": [
+ "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
+ "BOTTOM_LEGEND",
+ "LEFT_LEGEND",
+ "RIGHT_LEGEND",
+ "TOP_LEGEND",
+ "NO_LEGEND"
+ ],
+ "description": "The position of the chart legend.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "The legend is rendered on the bottom of the chart.",
+ "The legend is rendered on the left of the chart.",
+ "The legend is rendered on the right of the chart.",
+ "The legend is rendered on the top of the chart.",
+ "No legend is rendered."
+ ]
+ },
"domains": {
"description": "The domain of data this is charting.\nOnly a single domain is currently supported.",
"type": "array",
@@ -2639,16 +2449,6 @@
}
},
"chartType": {
- "type": "string",
- "enumDescriptions": [
- "Default value, do not use.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
- "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
- "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e."
- ],
"enum": [
"BASIC_CHART_TYPE_UNSPECIFIED",
"BAR",
@@ -2658,7 +2458,17 @@
"SCATTER",
"COMBO"
],
- "description": "The type of the chart."
+ "description": "The type of the chart.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value, do not use.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.",
+ "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.",
+ "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e."
+ ]
},
"series": {
"description": "The data this chart is visualizing.",
@@ -2666,26 +2476,6 @@
"items": {
"$ref": "BasicChartSeries"
}
- },
- "legendPosition": {
- "enumDescriptions": [
- "Default value, do not use.",
- "The legend is rendered on the bottom of the chart.",
- "The legend is rendered on the left of the chart.",
- "The legend is rendered on the right of the chart.",
- "The legend is rendered on the top of the chart.",
- "No legend is rendered."
- ],
- "enum": [
- "BASIC_CHART_LEGEND_POSITION_UNSPECIFIED",
- "BOTTOM_LEGEND",
- "LEFT_LEGEND",
- "RIGHT_LEGEND",
- "TOP_LEGEND",
- "NO_LEGEND"
- ],
- "description": "The position of the chart legend.",
- "type": "string"
}
},
"id": "BasicChartSpec"
@@ -2695,18 +2485,39 @@
"type": "object",
"properties": {
"rule": {
- "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.",
- "$ref": "DataValidationRule"
+ "$ref": "DataValidationRule",
+ "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range."
},
"range": {
- "$ref": "GridRange",
- "description": "The range the data validation rule should apply to."
+ "description": "The range the data validation rule should apply to.",
+ "$ref": "GridRange"
}
},
"id": "SetDataValidationRequest"
},
"CellData": {
+ "description": "Data about a specific cell.",
+ "type": "object",
"properties": {
+ "effectiveValue": {
+ "$ref": "ExtendedValue",
+ "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only."
+ },
+ "formattedValue": {
+ "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.",
+ "type": "string"
+ },
+ "textFormatRuns": {
+ "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
+ "type": "array",
+ "items": {
+ "$ref": "TextFormatRun"
+ }
+ },
+ "hyperlink": {
+ "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula.)",
+ "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."
@@ -2720,40 +2531,19 @@
"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."
- },
- "userEnteredValue": {
- "$ref": "ExtendedValue",
- "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format."
+ "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only.",
+ "$ref": "CellFormat"
},
"dataValidation": {
"$ref": "DataValidationRule",
"description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule."
},
- "effectiveValue": {
- "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only.",
+ "userEnteredValue": {
+ "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format.",
"$ref": "ExtendedValue"
- },
- "formattedValue": {
- "type": "string",
- "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only."
- },
- "textFormatRuns": {
- "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.",
- "type": "array",
- "items": {
- "$ref": "TextFormatRun"
- }
- },
- "hyperlink": {
- "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula.)",
- "type": "string"
}
},
- "id": "CellData",
- "description": "Data about a specific cell.",
- "type": "object"
+ "id": "CellData"
},
"BatchUpdateSpreadsheetRequest": {
"description": "The request for updating any aspect of a spreadsheet.",
@@ -2785,6 +2575,8 @@
"id": "BatchUpdateSpreadsheetRequest"
},
"Padding": {
+ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
+ "type": "object",
"properties": {
"right": {
"description": "The right padding of the cell.",
@@ -2797,9 +2589,9 @@
"type": "integer"
},
"top": {
- "type": "integer",
"description": "The top padding of the cell.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"left": {
"description": "The left padding of the cell.",
@@ -2807,13 +2599,21 @@
"type": "integer"
}
},
- "id": "Padding",
- "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.",
- "type": "object"
+ "id": "Padding"
},
"BasicChartAxis": {
"properties": {
+ "format": {
+ "description": "The format of the title.\nOnly valid if the axis is not associated with the domain.",
+ "$ref": "TextFormat"
+ },
"position": {
+ "enum": [
+ "BASIC_CHART_AXIS_POSITION_UNSPECIFIED",
+ "BOTTOM_AXIS",
+ "LEFT_AXIS",
+ "RIGHT_AXIS"
+ ],
"description": "The position of this axis.",
"type": "string",
"enumDescriptions": [
@@ -2821,21 +2621,11 @@
"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"
]
},
"title": {
"description": "The title of this axis. If set, this overrides any title inferred\nfrom headers of the data.",
"type": "string"
- },
- "format": {
- "description": "The format of the title.\nOnly valid if the axis is not associated with the domain.",
- "$ref": "TextFormat"
}
},
"id": "BasicChartAxis",
@@ -2847,29 +2637,31 @@
"type": "object",
"properties": {
"range": {
- "description": "The dimensions to delete from the sheet.",
- "$ref": "DimensionRange"
+ "$ref": "DimensionRange",
+ "description": "The dimensions to delete from the sheet."
}
},
"id": "DeleteDimensionRequest"
},
"UpdateChartSpecRequest": {
- "description": "Updates a chart's specifications.\n(This does not move or resize a chart. To move or resize a chart, use\n UpdateEmbeddedObjectPositionRequest.)",
- "type": "object",
"properties": {
"chartId": {
- "type": "integer",
"description": "The ID of the chart to update.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"spec": {
"$ref": "ChartSpec",
"description": "The specification to apply to the chart."
}
},
- "id": "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"
},
"DeleteFilterViewRequest": {
+ "description": "Deletes a particular filter view.",
+ "type": "object",
"properties": {
"filterId": {
"description": "The ID of the filter to delete.",
@@ -2877,33 +2669,10 @@
"type": "integer"
}
},
- "id": "DeleteFilterViewRequest",
- "description": "Deletes a particular filter view.",
- "type": "object"
+ "id": "DeleteFilterViewRequest"
},
"BatchUpdateValuesResponse": {
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
"properties": {
- "totalUpdatedSheets": {
- "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "totalUpdatedCells": {
- "type": "integer",
- "description": "The total number of cells updated.",
- "format": "int32"
- },
- "totalUpdatedColumns": {
- "description": "The total number of columns where at least one cell in the column was\nupdated.",
- "format": "int32",
- "type": "integer"
- },
- "spreadsheetId": {
- "description": "The spreadsheet the updates were applied to.",
- "type": "string"
- },
"totalUpdatedRows": {
"description": "The total number of rows where at least one cell in the row was updated.",
"format": "int32",
@@ -2915,13 +2684,32 @@
"items": {
"$ref": "UpdateValuesResponse"
}
+ },
+ "totalUpdatedSheets": {
+ "description": "The total number of sheets where at least one cell in the sheet was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedCells": {
+ "description": "The total number of cells updated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalUpdatedColumns": {
+ "description": "The total number of columns where at least one cell in the column was\nupdated.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
}
},
- "id": "BatchUpdateValuesResponse"
+ "id": "BatchUpdateValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object"
},
"SortRangeRequest": {
- "description": "Sorts data in rows based on a sort order per column.",
- "type": "object",
"properties": {
"range": {
"description": "The range to sort.",
@@ -2935,11 +2723,11 @@
}
}
},
- "id": "SortRangeRequest"
+ "id": "SortRangeRequest",
+ "description": "Sorts data in rows based on a sort order per column.",
+ "type": "object"
},
"MergeCellsRequest": {
- "description": "Merges all cells in the range.",
- "type": "object",
"properties": {
"mergeType": {
"enumDescriptions": [
@@ -2956,22 +2744,24 @@
"type": "string"
},
"range": {
- "description": "The range of cells to merge.",
- "$ref": "GridRange"
+ "$ref": "GridRange",
+ "description": "The range of cells to merge."
}
},
- "id": "MergeCellsRequest"
+ "id": "MergeCellsRequest",
+ "description": "Merges all cells in the range.",
+ "type": "object"
},
"AddProtectedRangeRequest": {
- "description": "Adds a new protected range.",
- "type": "object",
"properties": {
"protectedRange": {
"$ref": "ProtectedRange",
"description": "The protected range to be added. The\nprotectedRangeId field is optional; if\none is not set, an id will be randomly generated. (It is an error to\nspecify the ID of a range that already exists.)"
}
},
- "id": "AddProtectedRangeRequest"
+ "id": "AddProtectedRangeRequest",
+ "description": "Adds a new protected range.",
+ "type": "object"
},
"BatchClearValuesRequest": {
"description": "The request for clearing more than one range of values in a spreadsheet.",
@@ -2999,15 +2789,15 @@
"id": "DuplicateFilterViewResponse"
},
"DuplicateSheetResponse": {
- "description": "The result of duplicating a sheet.",
- "type": "object",
"properties": {
"properties": {
- "$ref": "SheetProperties",
- "description": "The properties of the duplicate sheet."
+ "description": "The properties of the duplicate sheet.",
+ "$ref": "SheetProperties"
}
},
- "id": "DuplicateSheetResponse"
+ "id": "DuplicateSheetResponse",
+ "description": "The result of duplicating a sheet.",
+ "type": "object"
},
"ClearBasicFilterRequest": {
"description": "Clears the basic filter, if any exists on the sheet.",
@@ -3022,16 +2812,16 @@
"id": "ClearBasicFilterRequest"
},
"TextToColumnsRequest": {
- "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
- "type": "object",
"properties": {
+ "delimiter": {
+ "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ "type": "string"
+ },
"source": {
- "$ref": "GridRange",
- "description": "The source data range. This must span exactly one column."
+ "description": "The source data range. This must span exactly one column.",
+ "$ref": "GridRange"
},
"delimiterType": {
- "description": "The delimiter type to use.",
- "type": "string",
"enumDescriptions": [
"Default value. This value must not be used.",
"\",\"",
@@ -3047,18 +2837,16 @@
"PERIOD",
"SPACE",
"CUSTOM"
- ]
- },
- "delimiter": {
- "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.",
+ ],
+ "description": "The delimiter type to use.",
"type": "string"
}
},
- "id": "TextToColumnsRequest"
+ "id": "TextToColumnsRequest",
+ "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.",
+ "type": "object"
},
"DeleteBandingRequest": {
- "description": "Removes the banded range with the given ID from the spreadsheet.",
- "type": "object",
"properties": {
"bandedRangeId": {
"description": "The ID of the banded range to delete.",
@@ -3066,11 +2854,11 @@
"type": "integer"
}
},
- "id": "DeleteBandingRequest"
+ "id": "DeleteBandingRequest",
+ "description": "Removes the banded range with the given ID from the spreadsheet.",
+ "type": "object"
},
"BatchUpdateSpreadsheetResponse": {
- "description": "The reply for batch updating a spreadsheet.",
- "type": "object",
"properties": {
"replies": {
"description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
@@ -3080,24 +2868,23 @@
}
},
"updatedSpreadsheet": {
- "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`.",
- "$ref": "Spreadsheet"
+ "$ref": "Spreadsheet",
+ "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`."
},
"spreadsheetId": {
"description": "The spreadsheet the updates were applied to.",
"type": "string"
}
},
- "id": "BatchUpdateSpreadsheetResponse"
+ "id": "BatchUpdateSpreadsheetResponse",
+ "description": "The reply for batch updating a spreadsheet.",
+ "type": "object"
},
"AppendValuesResponse": {
- "id": "AppendValuesResponse",
- "description": "The response when updating a range of values in a spreadsheet.",
- "type": "object",
"properties": {
"updates": {
- "description": "Information about the updates that were applied.",
- "$ref": "UpdateValuesResponse"
+ "$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.",
@@ -3107,28 +2894,23 @@
"description": "The spreadsheet the updates were applied to.",
"type": "string"
}
- }
+ },
+ "id": "AppendValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object"
},
- "MoveDimensionRequest": {
- "description": "Moves one or more rows or columns.",
- "type": "object",
+ "AddFilterViewRequest": {
"properties": {
- "source": {
- "description": "The source dimensions to move.",
- "$ref": "DimensionRange"
- },
- "destinationIndex": {
- "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
- "format": "int32",
- "type": "integer"
+ "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": "MoveDimensionRequest"
+ "id": "AddFilterViewRequest",
+ "description": "Adds a filter view.",
+ "type": "object"
},
"PivotFilterCriteria": {
- "id": "PivotFilterCriteria",
- "description": "Criteria for showing/hiding rows in a pivot table.",
- "type": "object",
"properties": {
"visibleValues": {
"description": "Values that should be included. Values not listed here are excluded.",
@@ -3137,31 +2919,39 @@
"type": "string"
}
}
- }
+ },
+ "id": "PivotFilterCriteria",
+ "description": "Criteria for showing/hiding rows in a pivot table.",
+ "type": "object"
},
- "AddFilterViewRequest": {
- "description": "Adds a filter view.",
+ "MoveDimensionRequest": {
+ "description": "Moves one or more rows or columns.",
"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"
+ "destinationIndex": {
+ "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "source": {
+ "$ref": "DimensionRange",
+ "description": "The source dimensions to move."
}
},
- "id": "AddFilterViewRequest"
+ "id": "MoveDimensionRequest"
},
"AddConditionalFormatRuleRequest": {
"description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.",
"type": "object",
"properties": {
- "rule": {
- "$ref": "ConditionalFormatRule",
- "description": "The rule to add."
- },
"index": {
"description": "The zero-based index where the rule should be inserted.",
"format": "int32",
"type": "integer"
+ },
+ "rule": {
+ "description": "The rule to add.",
+ "$ref": "ConditionalFormatRule"
}
},
"id": "AddConditionalFormatRuleRequest"
@@ -3169,16 +2959,14 @@
"ChartSpec": {
"properties": {
"pieChart": {
- "$ref": "PieChartSpec",
- "description": "A pie chart specification."
+ "description": "A pie chart specification.",
+ "$ref": "PieChartSpec"
},
"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"
},
"hiddenDimensionStrategy": {
- "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.",
@@ -3192,7 +2980,9 @@
"SKIP_HIDDEN_ROWS",
"SKIP_HIDDEN_COLUMNS",
"SHOW_ALL"
- ]
+ ],
+ "description": "Determines how the charts will use hidden rows or columns.",
+ "type": "string"
},
"title": {
"description": "The title of the chart.",
@@ -3207,6 +2997,10 @@
"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": {
"enum": [
"NUMBER_FORMAT_TYPE_UNSPECIFIED",
@@ -3232,31 +3026,21 @@
"Date+Time formatting, e.g `9/26/08 15:59:00`",
"Scientific number formatting, e.g `1.01E+03`"
]
- },
- "pattern": {
- "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.",
- "type": "string"
}
},
"id": "NumberFormat"
},
"SheetProperties": {
- "description": "Properties of a sheet.",
- "type": "object",
"properties": {
- "title": {
- "description": "The name of the sheet.",
- "type": "string"
- },
- "tabColor": {
- "description": "The color of the tab in the UI.",
- "$ref": "Color"
- },
"index": {
"description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.",
"format": "int32",
"type": "integer"
},
+ "tabColor": {
+ "$ref": "Color",
+ "description": "The color of the tab in the UI."
+ },
"sheetId": {
"description": "The ID of the sheet. Must be non-negative.\nThis field cannot be changed once set.",
"format": "int32",
@@ -3270,41 +3054,47 @@
"description": "True if the sheet is hidden in the UI, false if it's visible.",
"type": "boolean"
},
- "gridProperties": {
- "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets.",
- "$ref": "GridProperties"
- },
"sheetType": {
+ "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."
- ],
- "enum": [
- "SHEET_TYPE_UNSPECIFIED",
- "GRID",
- "OBJECT"
]
+ },
+ "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."
+ },
+ "title": {
+ "description": "The name of the sheet.",
+ "type": "string"
}
},
- "id": "SheetProperties"
+ "id": "SheetProperties",
+ "description": "Properties of a sheet.",
+ "type": "object"
},
"UpdateDimensionPropertiesRequest": {
"properties": {
- "range": {
- "description": "The rows or columns to update.",
- "$ref": "DimensionRange"
- },
"fields": {
"description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
"format": "google-fieldmask",
"type": "string"
},
"properties": {
- "$ref": "DimensionProperties",
- "description": "Properties to update."
+ "description": "Properties to update.",
+ "$ref": "DimensionProperties"
+ },
+ "range": {
+ "$ref": "DimensionRange",
+ "description": "The rows or columns to update."
}
},
"id": "UpdateDimensionPropertiesRequest",
@@ -3312,12 +3102,15 @@
"type": "object"
},
"SourceAndDestination": {
- "description": "A combination of a source range and how to extend that source.",
- "type": "object",
"properties": {
+ "fillLength": {
+ "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
+ "format": "int32",
+ "type": "integer"
+ },
"source": {
- "$ref": "GridRange",
- "description": "The location of the data to use as the source of the autofill."
+ "description": "The location of the data to use as the source of the autofill.",
+ "$ref": "GridRange"
},
"dimension": {
"enumDescriptions": [
@@ -3332,40 +3125,14 @@
],
"description": "The dimension that data should be filled into.",
"type": "string"
- },
- "fillLength": {
- "description": "The number of rows or columns that data should be filled into.\nPositive numbers expand beyond the last row or last column\nof the source. Negative numbers expand before the first row\nor first column of the source.",
- "format": "int32",
- "type": "integer"
}
},
- "id": "SourceAndDestination"
+ "id": "SourceAndDestination",
+ "description": "A combination of a source range and how to extend that source.",
+ "type": "object"
},
"FilterView": {
- "id": "FilterView",
- "description": "A filter view.",
- "type": "object",
"properties": {
- "filterViewId": {
- "description": "The ID of the filter view.",
- "format": "int32",
- "type": "integer"
- },
- "criteria": {
- "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.",
- "type": "object",
- "additionalProperties": {
- "$ref": "FilterCriteria"
- }
- },
- "title": {
- "description": "The name of the filter view.",
- "type": "string"
- },
- "range": {
- "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
- "$ref": "GridRange"
- },
"sortSpecs": {
"description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.",
"type": "array",
@@ -3376,13 +3143,44 @@
"namedRangeId": {
"description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
"type": "string"
+ },
+ "filterViewId": {
+ "description": "The ID of the filter view.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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."
}
- }
+ },
+ "id": "FilterView",
+ "description": "A filter view.",
+ "type": "object"
},
"BandingProperties": {
"description": "Properties referring a single dimension (either row or column). If both\nBandedRange.row_properties and BandedRange.column_properties are\nset, the fill colors are applied to cells according to the following rules:\n\n* header_color and footer_color take priority over band colors.\n* first_band_color takes priority over second_band_color.\n* row_properties takes priority over column_properties.\n\nFor example, the first row color takes priority over the first column\ncolor, but the first column color takes priority over the second row color.\nSimilarly, the row header takes priority over the column header in the\ntop left cell, but the column header takes priority over the first row\ncolor if the row header is not set.",
"type": "object",
"properties": {
+ "footerColor": {
+ "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.",
+ "$ref": "Color"
+ },
+ "headerColor": {
+ "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would.",
+ "$ref": "Color"
+ },
"firstBandColor": {
"description": "The first color that is alternating. (Required)",
"$ref": "Color"
@@ -3390,29 +3188,10 @@
"secondBandColor": {
"$ref": "Color",
"description": "The second color that is alternating. (Required)"
- },
- "footerColor": {
- "$ref": "Color",
- "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn."
- },
- "headerColor": {
- "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would.",
- "$ref": "Color"
}
},
"id": "BandingProperties"
},
- "AddProtectedRangeResponse": {
- "properties": {
- "protectedRange": {
- "$ref": "ProtectedRange",
- "description": "The newly added protected range."
- }
- },
- "id": "AddProtectedRangeResponse",
- "description": "The result of adding a new protected range.",
- "type": "object"
- },
"BasicFilter": {
"description": "The default filter associated with a sheet.",
"type": "object",
@@ -3438,6 +3217,17 @@
},
"id": "BasicFilter"
},
+ "AddProtectedRangeResponse": {
+ "description": "The result of adding a new protected range.",
+ "type": "object",
+ "properties": {
+ "protectedRange": {
+ "$ref": "ProtectedRange",
+ "description": "The newly added protected range."
+ }
+ },
+ "id": "AddProtectedRangeResponse"
+ },
"UpdateValuesResponse": {
"description": "The response when updating a range of values in a spreadsheet.",
"type": "object",
@@ -3457,8 +3247,8 @@
"type": "integer"
},
"spreadsheetId": {
- "type": "string",
- "description": "The spreadsheet the updates were applied to."
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
},
"updatedRange": {
"description": "The range (in A1 notation) that updates were applied to.",
@@ -3477,6 +3267,18 @@
"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",
@@ -3490,19 +3292,7 @@
"LOADING"
],
"description": "The type of error.",
- "type": "string",
- "enumDescriptions": [
- "The default error type, do not use this.",
- "Corresponds to the `#ERROR!` error.",
- "Corresponds to the `#NULL!` error.",
- "Corresponds to the `#DIV/0` error.",
- "Corresponds to the `#VALUE!` error.",
- "Corresponds to the `#REF!` error.",
- "Corresponds to the `#NAME?` error.",
- "Corresponds to the `#NUM`! error.",
- "Corresponds to the `#N/A` error.",
- "Corresponds to the `Loading...` state."
- ]
+ "type": "string"
},
"message": {
"description": "A message with more information about the error\n(in the spreadsheet's locale).",
@@ -3515,20 +3305,28 @@
"description": "The definition of how a value in a pivot table should be calculated.",
"type": "object",
"properties": {
- "sourceColumnOffset": {
- "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "description": "A name to use for the value. This is only used if formula was set.\nOtherwise, the column name is used.",
- "type": "string"
- },
"formula": {
"description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.",
"type": "string"
},
"summarizeFunction": {
+ "enumDescriptions": [
+ "The default, do not use.",
+ "Corresponds to the `SUM` function.",
+ "Corresponds to the `COUNTA` function.",
+ "Corresponds to the `COUNT` function.",
+ "Corresponds to the `COUNTUNIQUE` function.",
+ "Corresponds to the `AVERAGE` function.",
+ "Corresponds to the `MAX` function.",
+ "Corresponds to the `MIN` function.",
+ "Corresponds to the `MEDIAN` function.",
+ "Corresponds to the `PRODUCT` function.",
+ "Corresponds to the `STDEV` function.",
+ "Corresponds to the `STDEVP` function.",
+ "Corresponds to the `VAR` function.",
+ "Corresponds to the `VARP` function.",
+ "Indicates the formula should be used as-is.\nOnly valid if PivotValue.formula was set."
+ ],
"enum": [
"PIVOT_STANDARD_VALUE_FUNCTION_UNSPECIFIED",
"SUM",
@@ -3547,29 +3345,22 @@
"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."
- ]
+ "type": "string"
+ },
+ "sourceColumnOffset": {
+ "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "A name to use for the value. 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": {
@@ -3577,8 +3368,817 @@
"type": "string"
}
},
- "id": "CopySheetToAnotherSpreadsheetRequest",
- "description": "The request to copy a sheet across spreadsheets."
+ "id": "CopySheetToAnotherSpreadsheetRequest"
+ },
+ "PivotGroupSortValueBucket": {
+ "description": "Information about which values in a pivot group should be used for sorting.",
+ "type": "object",
+ "properties": {
+ "buckets": {
+ "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.",
+ "type": "array",
+ "items": {
+ "$ref": "ExtendedValue"
+ }
+ },
+ "valuesIndex": {
+ "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "PivotGroupSortValueBucket"
+ },
+ "EmbeddedObjectPosition": {
+ "properties": {
+ "newSheet": {
+ "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.",
+ "type": "boolean"
+ },
+ "sheetId": {
+ "description": "The sheet this is on. Set only if the embedded object\nis on its own sheet. Must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "overlayPosition": {
+ "$ref": "OverlayPosition",
+ "description": "The position at which the object is overlaid on top of a grid."
+ }
+ },
+ "id": "EmbeddedObjectPosition",
+ "description": "The position of an embedded object such as a chart.",
+ "type": "object"
+ },
+ "DeleteProtectedRangeRequest": {
+ "description": "Deletes the protected range with the given ID.",
+ "type": "object",
+ "properties": {
+ "protectedRangeId": {
+ "description": "The ID of the protected range to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteProtectedRangeRequest"
+ },
+ "AutoFillRequest": {
+ "properties": {
+ "useAlternateSeries": {
+ "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.",
+ "type": "boolean"
+ },
+ "sourceAndDestination": {
+ "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.",
+ "$ref": "SourceAndDestination"
+ },
+ "range": {
+ "$ref": "GridRange",
+ "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range."
+ }
+ },
+ "id": "AutoFillRequest",
+ "description": "Fills in more data based on existing data.",
+ "type": "object"
+ },
+ "GradientRule": {
+ "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.",
+ "type": "object",
+ "properties": {
+ "midpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "An optional midway interpolation point."
+ },
+ "minpoint": {
+ "$ref": "InterpolationPoint",
+ "description": "The starting interpolation point."
+ },
+ "maxpoint": {
+ "description": "The final interpolation point.",
+ "$ref": "InterpolationPoint"
+ }
+ },
+ "id": "GradientRule"
+ },
+ "SetBasicFilterRequest": {
+ "properties": {
+ "filter": {
+ "$ref": "BasicFilter",
+ "description": "The filter to set."
+ }
+ },
+ "id": "SetBasicFilterRequest",
+ "description": "Sets the basic filter associated with a sheet.",
+ "type": "object"
+ },
+ "ClearValuesRequest": {
+ "description": "The request for clearing a range of values in a spreadsheet.",
+ "type": "object",
+ "properties": {},
+ "id": "ClearValuesRequest"
+ },
+ "InterpolationPoint": {
+ "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.",
+ "type": "string"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "The color this interpolation point should use."
+ },
+ "type": {
+ "enum": [
+ "INTERPOLATION_POINT_TYPE_UNSPECIFIED",
+ "MIN",
+ "MAX",
+ "NUMBER",
+ "PERCENT",
+ "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)."
+ ]
+ }
+ },
+ "id": "InterpolationPoint"
+ },
+ "DeleteEmbeddedObjectRequest": {
+ "properties": {
+ "objectId": {
+ "description": "The ID of the embedded object to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteEmbeddedObjectRequest",
+ "description": "Deletes the embedded object with the given ID.",
+ "type": "object"
+ },
+ "FindReplaceResponse": {
+ "description": "The result of the find/replace.",
+ "type": "object",
+ "properties": {
+ "sheetsChanged": {
+ "description": "The number of sheets changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "formulasChanged": {
+ "description": "The number of formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "valuesChanged": {
+ "description": "The number of non-formula cells changed.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "occurrencesChanged": {
+ "description": "The number of occurrences (possibly multiple within a cell) changed.\nFor example, if replacing `\"e\"` with `\"o\"` in `\"Google Sheets\"`, this would\nbe `\"3\"` because `\"Google Sheets\"` -\u003e `\"Googlo Shoots\"`.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowsChanged": {
+ "description": "The number of rows changed.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "FindReplaceResponse"
+ },
+ "DuplicateFilterViewRequest": {
+ "description": "Duplicates a particular filter view.",
+ "type": "object",
+ "properties": {
+ "filterId": {
+ "description": "The ID of the filter being duplicated.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateFilterViewRequest"
+ },
+ "DeleteSheetRequest": {
+ "properties": {
+ "sheetId": {
+ "description": "The ID of the sheet to delete.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DeleteSheetRequest",
+ "description": "Deletes the requested sheet.",
+ "type": "object"
+ },
+ "UpdateConditionalFormatRuleResponse": {
+ "properties": {
+ "oldIndex": {
+ "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newRule": {
+ "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)",
+ "$ref": "ConditionalFormatRule"
+ },
+ "oldRule": {
+ "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule).",
+ "$ref": "ConditionalFormatRule"
+ },
+ "newIndex": {
+ "description": "The index of the new rule.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateConditionalFormatRuleResponse",
+ "description": "The result of updating a conditional format rule.",
+ "type": "object"
+ },
+ "DuplicateSheetRequest": {
+ "properties": {
+ "newSheetName": {
+ "description": "The name of the new sheet. If empty, a new name is chosen for you.",
+ "type": "string"
+ },
+ "sourceSheetId": {
+ "description": "The sheet to duplicate.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "newSheetId": {
+ "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "insertSheetIndex": {
+ "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DuplicateSheetRequest",
+ "description": "Duplicates the contents of a sheet.",
+ "type": "object"
+ },
+ "ConditionValue": {
+ "properties": {
+ "relativeDate": {
+ "enum": [
+ "RELATIVE_DATE_UNSPECIFIED",
+ "PAST_YEAR",
+ "PAST_MONTH",
+ "PAST_WEEK",
+ "YESTERDAY",
+ "TODAY",
+ "TOMORROW"
+ ],
+ "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.",
+ "type": "string",
+ "enumDescriptions": [
+ "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."
+ ]
+ },
+ "userEnteredValue": {
+ "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).",
+ "type": "string"
+ }
+ },
+ "id": "ConditionValue",
+ "description": "The value of the condition.",
+ "type": "object"
+ },
+ "ExtendedValue": {
+ "properties": {
+ "numberValue": {
+ "description": "Represents a double value.\nNote: Dates, Times and DateTimes are represented as doubles in\n\"serial number\" format.",
+ "format": "double",
+ "type": "number"
+ },
+ "errorValue": {
+ "description": "Represents an error.\nThis field is read-only.",
+ "$ref": "ErrorValue"
+ },
+ "stringValue": {
+ "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "Represents a boolean value.",
+ "type": "boolean"
+ },
+ "formulaValue": {
+ "description": "Represents a formula.",
+ "type": "string"
+ }
+ },
+ "id": "ExtendedValue",
+ "description": "The kinds of value that a cell in a spreadsheet can have.",
+ "type": "object"
+ },
+ "AddChartRequest": {
+ "properties": {
+ "chart": {
+ "$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",
+ "description": "Adds a chart to a sheet in the spreadsheet.",
+ "type": "object"
+ },
+ "Spreadsheet": {
+ "description": "Resource that represents a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "Overall properties of a spreadsheet."
+ },
+ "spreadsheetId": {
+ "description": "The ID of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ },
+ "sheets": {
+ "description": "The sheets that are part of a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "Sheet"
+ }
+ },
+ "namedRanges": {
+ "description": "The named ranges defined in a spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "NamedRange"
+ }
+ },
+ "spreadsheetUrl": {
+ "description": "The url of the spreadsheet.\nThis field is read-only.",
+ "type": "string"
+ }
+ },
+ "id": "Spreadsheet"
+ },
+ "BatchClearValuesResponse": {
+ "properties": {
+ "spreadsheetId": {
+ "description": "The spreadsheet the updates were applied to.",
+ "type": "string"
+ },
+ "clearedRanges": {
+ "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "BatchClearValuesResponse",
+ "description": "The response when updating a range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "BandedRange": {
+ "properties": {
+ "bandedRangeId": {
+ "description": "The id of the banded range.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowProperties": {
+ "$ref": "BandingProperties",
+ "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified."
+ },
+ "columnProperties": {
+ "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified.",
+ "$ref": "BandingProperties"
+ },
+ "range": {
+ "description": "The range over which these properties are applied.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "BandedRange",
+ "description": "A banded (alternating colors) range in a sheet.",
+ "type": "object"
+ },
+ "UpdateProtectedRangeRequest": {
+ "properties": {
+ "protectedRange": {
+ "description": "The protected range to update with the new properties.",
+ "$ref": "ProtectedRange"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateProtectedRangeRequest",
+ "description": "Updates an existing protected range with the specified\nprotectedRangeId.",
+ "type": "object"
+ },
+ "TextFormat": {
+ "properties": {
+ "underline": {
+ "description": "True if the text is underlined.",
+ "type": "boolean"
+ },
+ "foregroundColor": {
+ "description": "The foreground color of the text.",
+ "$ref": "Color"
+ },
+ "bold": {
+ "description": "True if the text is bold.",
+ "type": "boolean"
+ },
+ "fontFamily": {
+ "description": "The font family.",
+ "type": "string"
+ },
+ "strikethrough": {
+ "description": "True if the text has a strikethrough.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "True if the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "description": "The size of the font.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextFormat",
+ "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.",
+ "type": "object"
+ },
+ "AddSheetResponse": {
+ "properties": {
+ "properties": {
+ "description": "The properties of the newly added sheet.",
+ "$ref": "SheetProperties"
+ }
+ },
+ "id": "AddSheetResponse",
+ "description": "The result of adding a sheet.",
+ "type": "object"
+ },
+ "AddFilterViewResponse": {
+ "properties": {
+ "filter": {
+ "description": "The newly added filter view.",
+ "$ref": "FilterView"
+ }
+ },
+ "id": "AddFilterViewResponse",
+ "description": "The result of adding a filter view.",
+ "type": "object"
+ },
+ "IterativeCalculationSettings": {
+ "properties": {
+ "convergenceThreshold": {
+ "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.",
+ "format": "double",
+ "type": "number"
+ },
+ "maxIterations": {
+ "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "IterativeCalculationSettings",
+ "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.",
+ "type": "object"
+ },
+ "SpreadsheetProperties": {
+ "description": "Properties of a spreadsheet.",
+ "type": "object",
+ "properties": {
+ "autoRecalc": {
+ "enum": [
+ "RECALCULATION_INTERVAL_UNSPECIFIED",
+ "ON_CHANGE",
+ "MINUTE",
+ "HOUR"
+ ],
+ "description": "The amount of time to wait before volatile functions are recalculated.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default value. This value must not be used.",
+ "Volatile functions are updated on every change.",
+ "Volatile functions are updated on every change and every minute.",
+ "Volatile functions are updated on every change and hourly."
+ ]
+ },
+ "defaultFormat": {
+ "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only.",
+ "$ref": "CellFormat"
+ },
+ "title": {
+ "description": "The title of the spreadsheet.",
+ "type": "string"
+ },
+ "timeZone": {
+ "description": "The time zone of the spreadsheet, in CLDR format such as\n`America/New_York`. If the time zone isn't recognized, this may\nbe a custom time zone such as `GMT-07:00`.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "The locale of the spreadsheet in one of the following formats:\n\n* an ISO 639-1 language code such as `en`\n\n* an ISO 639-2 language code such as `fil`, if no 639-1 code exists\n\n* a combination of the ISO language code and country code, such as `en_US`\n\nNote: when updating this field, not all locales/languages are supported.",
+ "type": "string"
+ },
+ "iterativeCalculationSettings": {
+ "$ref": "IterativeCalculationSettings",
+ "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors."
+ }
+ },
+ "id": "SpreadsheetProperties"
+ },
+ "OverlayPosition": {
+ "description": "The location an object is overlaid on top of a grid.",
+ "type": "object",
+ "properties": {
+ "offsetXPixels": {
+ "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "anchorCell": {
+ "description": "The cell the object is anchored to.",
+ "$ref": "GridCoordinate"
+ },
+ "offsetYPixels": {
+ "description": "The vertical offset, in pixels, that the object is offset\nfrom the anchor cell.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "heightPixels": {
+ "description": "The height of the object, in pixels. Defaults to 371.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "widthPixels": {
+ "description": "The width of the object, in pixels. Defaults to 600.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "OverlayPosition"
+ },
+ "RepeatCellRequest": {
+ "properties": {
+ "range": {
+ "description": "The range to repeat the cell in.",
+ "$ref": "GridRange"
+ },
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "cell": {
+ "$ref": "CellData",
+ "description": "The data to write."
+ }
+ },
+ "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"
+ },
+ "AddChartResponse": {
+ "properties": {
+ "chart": {
+ "description": "The newly added chart.",
+ "$ref": "EmbeddedChart"
+ }
+ },
+ "id": "AddChartResponse",
+ "description": "The result of adding a chart to a spreadsheet.",
+ "type": "object"
+ },
+ "InsertDimensionRequest": {
+ "properties": {
+ "inheritFromBefore": {
+ "description": "Whether dimension properties should be extended from the dimensions\nbefore or after the newly inserted dimensions.\nTrue to inherit from the dimensions before (in which case the start\nindex must be greater than 0), and false to inherit from the dimensions\nafter.\n\nFor example, if row index 0 has red background and row index 1\nhas a green background, then inserting 2 rows at index 1 can inherit\neither the green or red background. If `inheritFromBefore` is true,\nthe two new rows will be red (because the row before the insertion point\nwas red), whereas if `inheritFromBefore` is false, the two new rows will\nbe green (because the row after the insertion point was green).",
+ "type": "boolean"
+ },
+ "range": {
+ "description": "The dimensions to insert. Both the start and end indexes must be bounded.",
+ "$ref": "DimensionRange"
+ }
+ },
+ "id": "InsertDimensionRequest",
+ "description": "Inserts rows or columns in a sheet at a particular index.",
+ "type": "object"
+ },
+ "UpdateSpreadsheetPropertiesRequest": {
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "SpreadsheetProperties",
+ "description": "The properties to update."
+ }
+ },
+ "id": "UpdateSpreadsheetPropertiesRequest",
+ "description": "Updates properties of a spreadsheet.",
+ "type": "object"
+ },
+ "BatchUpdateValuesRequest": {
+ "properties": {
+ "responseValueRenderOption": {
+ "enum": [
+ "FORMATTED_VALUE",
+ "UNFORMATTED_VALUE",
+ "FORMULA"
+ ],
+ "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
+ "type": "string",
+ "enumDescriptions": [
+ "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.",
+ "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.",
+ "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`."
+ ]
+ },
+ "includeValuesInResponse": {
+ "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).",
+ "type": "boolean"
+ },
+ "valueInputOption": {
+ "enum": [
+ "INPUT_VALUE_OPTION_UNSPECIFIED",
+ "RAW",
+ "USER_ENTERED"
+ ],
+ "description": "How the input data should be interpreted.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default input value. This value must not be used.",
+ "The values the user has entered will not be parsed and will be stored\nas-is.",
+ "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI."
+ ]
+ },
+ "data": {
+ "description": "The new values to apply to the spreadsheet.",
+ "type": "array",
+ "items": {
+ "$ref": "ValueRange"
+ }
+ },
+ "responseDateTimeRenderOption": {
+ "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",
+ "enumDescriptions": [
+ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nDays are counted from December 31st 1899 and are incremented by 1,\nand times are fractions of a day. For example, January 1st 1900 at noon\nwould be 1.5, 1 because it's 1 day offset from December 31st 1899,\nand .5 because noon is half a day. February 1st 1900 at 3pm would\nbe 32.625. This correctly treats the year 1900 as not 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)."
+ ]
+ }
+ },
+ "id": "BatchUpdateValuesRequest",
+ "description": "The request for updating more than one range of values in a spreadsheet.",
+ "type": "object"
+ },
+ "ProtectedRange": {
+ "description": "A protected range.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "The description of this protected range.",
+ "type": "string"
+ },
+ "unprotectedRanges": {
+ "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.",
+ "type": "array",
+ "items": {
+ "$ref": "GridRange"
+ }
+ },
+ "namedRangeId": {
+ "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "type": "string"
+ },
+ "protectedRangeId": {
+ "description": "The ID of the protected range.\nThis field is read-only.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "warningOnly": {
+ "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.",
+ "type": "boolean"
+ },
+ "requestingUserCanEdit": {
+ "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "range": {
+ "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.",
+ "$ref": "GridRange"
+ },
+ "editors": {
+ "$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."
+ }
+ },
+ "id": "ProtectedRange"
+ },
+ "DimensionProperties": {
+ "properties": {
+ "pixelSize": {
+ "description": "The height (if a row) or width (if a column) of the dimension in pixels.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hiddenByFilter": {
+ "description": "True if this dimension is being filtered.\nThis field is read-only.",
+ "type": "boolean"
+ },
+ "hiddenByUser": {
+ "description": "True if this dimension is explicitly hidden.",
+ "type": "boolean"
+ }
+ },
+ "id": "DimensionProperties",
+ "description": "Properties about a dimension.",
+ "type": "object"
+ },
+ "NamedRange": {
+ "properties": {
+ "name": {
+ "description": "The name of the named range.",
+ "type": "string"
+ },
+ "namedRangeId": {
+ "description": "The ID of the named range.",
+ "type": "string"
+ },
+ "range": {
+ "description": "The range this represents.",
+ "$ref": "GridRange"
+ }
+ },
+ "id": "NamedRange",
+ "description": "A named range.",
+ "type": "object"
+ },
+ "DimensionRange": {
+ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.",
+ "type": "object",
+ "properties": {
+ "dimension": {
+ "enumDescriptions": [
+ "The default value, do not use.",
+ "Operates on the rows of a sheet.",
+ "Operates on the columns of a sheet."
+ ],
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ROWS",
+ "COLUMNS"
+ ],
+ "description": "The dimension of the span.",
+ "type": "string"
+ },
+ "startIndex": {
+ "description": "The start (inclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The end (exclusive) of the span, or not set if unbounded.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sheetId": {
+ "description": "The sheet this span is on.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "DimensionRange"
}
},
"icons": {
@@ -3609,605 +4209,5 @@
"ownerDomain": "google.com",
"name": "sheets",
"batchPath": "batch",
- "title": "Google Sheets API",
- "ownerName": "Google",
- "resources": {
- "spreadsheets": {
- "methods": {
- "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"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The spreadsheet to request.",
- "required": true,
- "type": "string"
- },
- "ranges": {
- "repeated": true,
- "location": "query",
- "description": "The ranges to retrieve from the spreadsheet.",
- "type": "string"
- },
- "includeGridData": {
- "location": "query",
- "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.",
- "type": "boolean"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}",
- "id": "sheets.spreadsheets.get",
- "path": "v4/spreadsheets/{spreadsheetId}"
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Spreadsheet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {},
- "flatPath": "v4/spreadsheets",
- "id": "sheets.spreadsheets.create",
- "path": "v4/spreadsheets",
- "description": "Creates a spreadsheet, returning the newly created spreadsheet.",
- "request": {
- "$ref": "Spreadsheet"
- }
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdateSpreadsheetResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The spreadsheet to apply the updates to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate",
- "id": "sheets.spreadsheets.batchUpdate",
- "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.",
- "request": {
- "$ref": "BatchUpdateSpreadsheetRequest"
- }
- }
- },
- "resources": {
- "sheets": {
- "methods": {
- "copyTo": {
- "id": "sheets.spreadsheets.sheets.copyTo",
- "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo",
- "request": {
- "$ref": "CopySheetToAnotherSpreadsheetRequest"
- },
- "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet.",
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId",
- "sheetId"
- ],
- "response": {
- "$ref": "SheetProperties"
- },
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet containing the sheet to copy.",
- "required": true,
- "type": "string"
- },
- "sheetId": {
- "location": "path",
- "description": "The ID of the sheet to copy.",
- "format": "int32",
- "required": true,
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo"
- }
- }
- },
- "values": {
- "methods": {
- "batchClear": {
- "httpMethod": "POST",
- "parameterOrder": [
- "spreadsheetId"
- ],
- "response": {
- "$ref": "BatchClearValuesResponse"
- },
- "parameters": {
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to update."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "id": "sheets.spreadsheets.values.batchClear",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear",
- "request": {
- "$ref": "BatchClearValuesRequest"
- },
- "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept."
- },
- "get": {
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from.",
- "required": true,
- "type": "string"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of the values to retrieve.",
- "required": true,
- "type": "string"
- },
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "dateTimeRenderOption": {
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- },
- "majorDimension": {
- "location": "query",
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "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.",
- "response": {
- "$ref": "ValueRange"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "GET"
- },
- "update": {
- "request": {
- "$ref": "ValueRange"
- },
- "description": "Sets values in a range of a spreadsheet.\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption.",
- "httpMethod": "PUT",
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "response": {
- "$ref": "UpdateValuesResponse"
- },
- "parameters": {
- "range": {
- "description": "The A1 notation of the values to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "includeValuesInResponse": {
- "location": "query",
- "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).",
- "type": "boolean"
- },
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "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": {
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string",
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ]
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}",
- "id": "sheets.spreadsheets.values.update",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}"
- },
- "batchUpdate": {
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to update."
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate",
- "id": "sheets.spreadsheets.values.batchUpdate",
- "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"
- },
- "clear": {
- "response": {
- "$ref": "ClearValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId",
- "range"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string",
- "location": "path"
- },
- "range": {
- "location": "path",
- "description": "The A1 notation of the values to clear.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear",
- "id": "sheets.spreadsheets.values.clear",
- "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.",
- "request": {
- "$ref": "ClearValuesRequest"
- }
- },
- "batchGet": {
- "httpMethod": "GET",
- "response": {
- "$ref": "BatchGetValuesResponse"
- },
- "parameterOrder": [
- "spreadsheetId"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "parameters": {
- "ranges": {
- "description": "The A1 notation of the values to retrieve.",
- "type": "string",
- "repeated": true,
- "location": "query"
- },
- "majorDimension": {
- "enum": [
- "DIMENSION_UNSPECIFIED",
- "ROWS",
- "COLUMNS"
- ],
- "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.",
- "type": "string",
- "location": "query"
- },
- "spreadsheetId": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The ID of the spreadsheet to retrieve data from."
- },
- "valueRenderOption": {
- "location": "query",
- "enum": [
- "FORMATTED_VALUE",
- "UNFORMATTED_VALUE",
- "FORMULA"
- ],
- "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.",
- "type": "string"
- },
- "dateTimeRenderOption": {
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "id": "sheets.spreadsheets.values.batchGet",
- "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet",
- "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges."
- },
- "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"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/spreadsheets"
- ],
- "parameters": {
- "spreadsheetId": {
- "location": "path",
- "description": "The ID of the spreadsheet to update.",
- "required": true,
- "type": "string"
- },
- "responseValueRenderOption": {
- "type": "string",
- "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."
- },
- "insertDataOption": {
- "enum": [
- "OVERWRITE",
- "INSERT_ROWS"
- ],
- "description": "How the input data should be inserted.",
- "type": "string",
- "location": "query"
- },
- "valueInputOption": {
- "location": "query",
- "enum": [
- "INPUT_VALUE_OPTION_UNSPECIFIED",
- "RAW",
- "USER_ENTERED"
- ],
- "description": "How the input data should be interpreted.",
- "type": "string"
- },
- "responseDateTimeRenderOption": {
- "location": "query",
- "enum": [
- "SERIAL_NUMBER",
- "FORMATTED_STRING"
- ],
- "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].",
- "type": "string"
- },
- "range": {
- "required": true,
- "type": "string",
- "location": "path",
- "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table."
- },
- "includeValuesInResponse": {
- "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.",
- "type": "boolean",
- "location": "query"
- }
- },
- "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append",
- "id": "sheets.spreadsheets.values.append",
- "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append"
- }
- }
- }
- }
- }
- },
- "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": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "upload_protocol": {
- "type": "string",
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")."
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "$.xgafv": {
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
- },
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query"
- }
- },
- "version": "v4",
- "baseUrl": "https://sheets.googleapis.com/",
- "kind": "discovery#restDescription",
- "description": "Reads and writes Google Sheets.",
- "servicePath": "",
- "basePath": "",
- "revision": "20170303",
- "id": "sheets:v4",
- "documentationLink": "https://developers.google.com/sheets/",
- "discoveryVersion": "v1",
- "version_module": "True"
+ "title": "Google Sheets API"
}
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json
index e7b4d6d..d2eb74a 100644
--- a/slides/v1/slides-api.json
+++ b/slides/v1/slides-api.json
@@ -1,4 +1,29 @@
{
+ "canonicalName": "Slides",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/spreadsheets.readonly": {
+ "description": "View your Google Spreadsheets"
+ },
+ "https://www.googleapis.com/auth/drive": {
+ "description": "View and manage the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/drive.readonly": {
+ "description": "View the files in your Google Drive"
+ },
+ "https://www.googleapis.com/auth/spreadsheets": {
+ "description": "View and manage your spreadsheets in Google Drive"
+ },
+ "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"
+ }
+ }
+ }
+ },
"rootUrl": "https://slides.googleapis.com/",
"ownerDomain": "google.com",
"name": "slides",
@@ -7,23 +32,112 @@
"ownerName": "Google",
"resources": {
"presentations": {
+ "resources": {
+ "pages": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest version of the specified page in the presentation.",
+ "response": {
+ "$ref": "Page"
+ },
+ "parameterOrder": [
+ "presentationId",
+ "pageObjectId"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "presentationId": {
+ "description": "The ID of the presentation to retrieve.",
+ "required": true,
+ "type": "string",
+ "location": "path"
+ },
+ "pageObjectId": {
+ "location": "path",
+ "description": "The object ID of the page to retrieve.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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}",
+ "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
+ "id": "slides.presentations.pages.get"
+ }
+ }
+ }
+ },
"methods": {
- "get": {
- "description": "Gets the latest version of the specified presentation.",
+ "create": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "Presentation"
},
+ "parameters": {},
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/presentations"
+ ],
+ "flatPath": "v1/presentations",
+ "id": "slides.presentations.create",
+ "path": "v1/presentations",
+ "request": {
+ "$ref": "Presentation"
+ },
+ "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation."
+ },
+ "batchUpdate": {
+ "flatPath": "v1/presentations/{presentationId}:batchUpdate",
+ "id": "slides.presentations.batchUpdate",
+ "path": "v1/presentations/{presentationId}:batchUpdate",
+ "request": {
+ "$ref": "BatchUpdatePresentationRequest"
+ },
+ "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically.",
+ "httpMethod": "POST",
"parameterOrder": [
"presentationId"
],
- "httpMethod": "GET",
+ "response": {
+ "$ref": "BatchUpdatePresentationResponse"
+ },
"parameters": {
"presentationId": {
- "pattern": "^[^/]+$",
+ "required": true,
+ "type": "string",
"location": "path",
+ "description": "The presentation to apply the updates to."
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/drive",
+ "https://www.googleapis.com/auth/drive.readonly",
+ "https://www.googleapis.com/auth/presentations",
+ "https://www.googleapis.com/auth/spreadsheets",
+ "https://www.googleapis.com/auth/spreadsheets.readonly"
+ ]
+ },
+ "get": {
+ "httpMethod": "GET",
+ "parameterOrder": [
+ "presentationId"
+ ],
+ "response": {
+ "$ref": "Presentation"
+ },
+ "parameters": {
+ "presentationId": {
"description": "The ID of the presentation to retrieve.",
"required": true,
- "type": "string"
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path"
}
},
"scopes": [
@@ -34,104 +148,78 @@
],
"flatPath": "v1/presentations/{presentationsId}",
"id": "slides.presentations.get",
- "path": "v1/presentations/{+presentationId}"
- },
- "create": {
- "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.",
- "request": {
- "$ref": "Presentation"
- },
- "httpMethod": "POST",
- "parameterOrder": [],
- "response": {
- "$ref": "Presentation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/presentations"
- ],
- "parameters": {},
- "flatPath": "v1/presentations",
- "id": "slides.presentations.create",
- "path": "v1/presentations"
- },
- "batchUpdate": {
- "response": {
- "$ref": "BatchUpdatePresentationResponse"
- },
- "parameterOrder": [
- "presentationId"
- ],
- "httpMethod": "POST",
- "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/spreadsheets",
- "https://www.googleapis.com/auth/spreadsheets.readonly"
- ],
- "parameters": {
- "presentationId": {
- "location": "path",
- "description": "The presentation to apply the updates to.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/presentations/{presentationId}:batchUpdate",
- "path": "v1/presentations/{presentationId}:batchUpdate",
- "id": "slides.presentations.batchUpdate",
- "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.",
- "request": {
- "$ref": "BatchUpdatePresentationRequest"
- }
- }
- },
- "resources": {
- "pages": {
- "methods": {
- "get": {
- "response": {
- "$ref": "Page"
- },
- "parameterOrder": [
- "presentationId",
- "pageObjectId"
- ],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/drive",
- "https://www.googleapis.com/auth/drive.readonly",
- "https://www.googleapis.com/auth/presentations",
- "https://www.googleapis.com/auth/presentations.readonly"
- ],
- "parameters": {
- "presentationId": {
- "location": "path",
- "description": "The ID of the presentation to retrieve.",
- "required": true,
- "type": "string"
- },
- "pageObjectId": {
- "location": "path",
- "description": "The object ID of the page to retrieve.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "path": "v1/presentations/{presentationId}/pages/{pageObjectId}",
- "id": "slides.presentations.pages.get",
- "description": "Gets the latest version of the specified page in the presentation."
- }
- }
+ "path": "v1/presentations/{+presentationId}",
+ "description": "Gets the latest version of the specified presentation."
}
}
}
},
"parameters": {
- "callback": {
- "description": "JSONP",
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "location": "query",
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "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"
},
@@ -148,1005 +236,31 @@
"description": "V1 error format.",
"type": "string"
},
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
+ "callback": {
"location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
+ "description": "JSONP",
"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": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "location": "query",
- "description": "OAuth bearer token.",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
}
},
"version": "v1",
"baseUrl": "https://slides.googleapis.com/",
- "kind": "discovery#restDescription",
"description": "An API for creating and editing Google Slides presentations.",
+ "kind": "discovery#restDescription",
"servicePath": "",
"basePath": "",
+ "revision": "20170301",
"documentationLink": "https://developers.google.com/slides/",
"id": "slides:v1",
- "revision": "20170301",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "ThemeColorPair": {
- "description": "A pair mapping a theme color type to the concrete color it represents.",
- "type": "object",
- "properties": {
- "color": {
- "description": "The concrete color corresponding to the theme color type above.",
- "$ref": "RgbColor"
- },
- "type": {
- "enumDescriptions": [
- "Unspecified theme color. This value should not be used.",
- "Represents the first dark color.",
- "Represents the first light color.",
- "Represents the second dark color.",
- "Represents the second light color.",
- "Represents the first accent color.",
- "Represents the second accent color.",
- "Represents the third accent color.",
- "Represents the fourth accent color.",
- "Represents the fifth accent color.",
- "Represents the sixth accent color.",
- "Represents the color to use for hyperlinks.",
- "Represents the color to use for visited hyperlinks.",
- "Represents the first text color.",
- "Represents the first background color.",
- "Represents the second text color.",
- "Represents the second background color."
- ],
- "enum": [
- "THEME_COLOR_TYPE_UNSPECIFIED",
- "DARK1",
- "LIGHT1",
- "DARK2",
- "LIGHT2",
- "ACCENT1",
- "ACCENT2",
- "ACCENT3",
- "ACCENT4",
- "ACCENT5",
- "ACCENT6",
- "HYPERLINK",
- "FOLLOWED_HYPERLINK",
- "TEXT1",
- "BACKGROUND1",
- "TEXT2",
- "BACKGROUND2"
- ],
- "description": "The type of the theme color.",
- "type": "string"
- }
- },
- "id": "ThemeColorPair"
- },
- "OptionalColor": {
- "description": "A color that can either be fully opaque or fully transparent.",
- "type": "object",
- "properties": {
- "opaqueColor": {
- "$ref": "OpaqueColor",
- "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
- }
- },
- "id": "OptionalColor"
- },
- "PageElementProperties": {
- "properties": {
- "transform": {
- "description": "The transform for the element.",
- "$ref": "AffineTransform"
- },
- "pageObjectId": {
- "type": "string",
- "description": "The object ID of the page where the element is located."
- },
- "size": {
- "description": "The size of the element.",
- "$ref": "Size"
- }
- },
- "id": "PageElementProperties",
- "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
- "type": "object"
- },
- "SheetsChartProperties": {
- "description": "The properties of the SheetsChart.",
- "type": "object",
- "properties": {
- "chartImageProperties": {
- "$ref": "ImageProperties",
- "description": "The properties of the embedded chart image."
- }
- },
- "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": {
- "type": "string",
- "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."
- }
- },
- "id": "StretchedPictureFill"
- },
- "UpdateTextStyleRequest": {
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the shape or table with the text to be styled.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
- },
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not."
- },
- "style": {
- "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information.",
- "$ref": "TextStyle"
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateTextStyleRequest",
- "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": {
- "description": "The table to delete columns from.",
- "type": "string"
- }
- },
- "id": "DeleteTableColumnRequest"
- },
- "List": {
- "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.",
- "type": "object",
- "properties": {
- "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"
- },
- "PageElement": {
- "description": "A visual element rendered on a page.",
- "type": "object",
- "properties": {
- "video": {
- "$ref": "Video",
- "description": "A video page element."
- },
- "wordArt": {
- "$ref": "WordArt",
- "description": "A word art page element."
- },
- "table": {
- "$ref": "Table",
- "description": "A table page element."
- },
- "transform": {
- "description": "The transform of the page element.",
- "$ref": "AffineTransform"
- },
- "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": {
- "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": {
- "description": "The size of the page element.",
- "$ref": "Size"
- },
- "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."
- }
- },
- "id": "PageElement"
- },
- "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.",
- "type": "string"
- }
- },
- "id": "CreateImageRequest"
- },
- "CreateParagraphBulletsRequest": {
- "id": "CreateParagraphBulletsRequest",
- "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
- "type": "object",
- "properties": {
- "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"
- },
- "objectId": {
- "description": "The object ID of the shape or table containing the text to add bullets to.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to apply the bullet presets to, based on TextElement indexes."
- },
- "bulletPreset": {
- "enum": [
- "BULLET_DISC_CIRCLE_SQUARE",
- "BULLET_DIAMONDX_ARROW3D_SQUARE",
- "BULLET_CHECKBOX",
- "BULLET_ARROW_DIAMOND_DISC",
- "BULLET_STAR_CIRCLE_SQUARE",
- "BULLET_ARROW3D_CIRCLE_SQUARE",
- "BULLET_LEFTTRIANGLE_DIAMOND_DISC",
- "BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE",
- "BULLET_DIAMOND_CIRCLE_SQUARE",
- "NUMBERED_DIGIT_ALPHA_ROMAN",
- "NUMBERED_DIGIT_ALPHA_ROMAN_PARENS",
- "NUMBERED_DIGIT_NESTED",
- "NUMBERED_UPPERALPHA_ALPHA_ROMAN",
- "NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT",
- "NUMBERED_ZERODIGIT_ALPHA_ROMAN"
- ],
- "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.",
- "type": "string",
- "enumDescriptions": [
- "A bulleted list with a `DISC`, `CIRCLE` and `SQUARE` bullet glyph for the\nfirst 3 list nesting levels.",
- "A bulleted list with a `DIAMONDX`, `ARROW3D` and `SQUARE` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with `CHECKBOX` bullet glyphs for all list nesting levels.",
- "A bulleted list with a `ARROW`, `DIAMOND` and `DISC` bullet glyph for\nthe first 3 list nesting levels.",
- "A bulleted list with a `STAR`, `CIRCLE` and `DISC` 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."
- ]
- }
- }
- },
- "TextStyle": {
- "id": "TextStyle",
- "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
- "type": "object",
- "properties": {
- "underline": {
- "description": "Whether or not the text is underlined.",
- "type": "boolean"
- },
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request."
- },
- "bold": {
- "description": "Whether or not the text is rendered as bold.",
- "type": "boolean"
- },
- "foregroundColor": {
- "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.",
- "$ref": "OptionalColor"
- },
- "fontFamily": {
- "type": "string",
- "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used."
- },
- "italic": {
- "description": "Whether or not the text is italicized.",
- "type": "boolean"
- },
- "strikethrough": {
- "description": "Whether or not the text is struck through.",
- "type": "boolean"
- },
- "fontSize": {
- "description": "The size of the text's font. When read, the `font_size` will specified in\npoints.",
- "$ref": "Dimension"
- },
- "smallCaps": {
- "description": "Whether or not the text is in small capital letters.",
- "type": "boolean"
- },
- "baselineOffset": {
- "enumDescriptions": [
- "The text's baseline offset is inherited from the parent.",
- "The text is not vertically offset.",
- "The text is vertically offset upwards (superscript).",
- "The text is vertically offset downwards (subscript)."
- ],
- "enum": [
- "BASELINE_OFFSET_UNSPECIFIED",
- "NONE",
- "SUPERSCRIPT",
- "SUBSCRIPT"
- ],
- "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
- "type": "string"
- },
- "backgroundColor": {
- "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.",
- "$ref": "OptionalColor"
- }
- }
- },
- "Size": {
- "id": "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."
- }
- }
- },
- "UpdateVideoPropertiesRequest": {
- "description": "Update the properties of a Video.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the video the updates are applied to.",
- "type": "string"
- },
- "videoProperties": {
- "$ref": "VideoProperties",
- "description": "The video properties to update."
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "UpdateVideoPropertiesRequest"
- },
- "Request": {
- "description": "A single kind of update to apply to a presentation.",
- "type": "object",
- "properties": {
- "replaceAllShapesWithImage": {
- "description": "Replaces all shapes matching some criteria with an image.",
- "$ref": "ReplaceAllShapesWithImageRequest"
- },
- "replaceAllText": {
- "$ref": "ReplaceAllTextRequest",
- "description": "Replaces all instances of specified text."
- },
- "updateImageProperties": {
- "$ref": "UpdateImagePropertiesRequest",
- "description": "Updates the properties of an Image."
- },
- "insertTableRows": {
- "$ref": "InsertTableRowsRequest",
- "description": "Inserts rows into a table."
- },
- "createSlide": {
- "description": "Creates a new slide.",
- "$ref": "CreateSlideRequest"
- },
- "updateLineProperties": {
- "$ref": "UpdateLinePropertiesRequest",
- "description": "Updates the properties of a Line."
- },
- "updateSlidesPosition": {
- "description": "Updates the position of a set of slides in the presentation.",
- "$ref": "UpdateSlidesPositionRequest"
- },
- "deleteTableRow": {
- "$ref": "DeleteTableRowRequest",
- "description": "Deletes a row from a table."
- },
- "updateShapeProperties": {
- "description": "Updates the properties of a Shape.",
- "$ref": "UpdateShapePropertiesRequest"
- },
- "insertText": {
- "$ref": "InsertTextRequest",
- "description": "Inserts text into a shape or table cell."
- },
- "deleteText": {
- "$ref": "DeleteTextRequest",
- "description": "Deletes text from a shape or a table cell."
- },
- "updatePageProperties": {
- "$ref": "UpdatePagePropertiesRequest",
- "description": "Updates the properties of a Page."
- },
- "deleteParagraphBullets": {
- "$ref": "DeleteParagraphBulletsRequest",
- "description": "Deletes bullets from paragraphs."
- },
- "createShape": {
- "description": "Creates a new shape.",
- "$ref": "CreateShapeRequest"
- },
- "insertTableColumns": {
- "description": "Inserts columns into a table.",
- "$ref": "InsertTableColumnsRequest"
- },
- "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": {
- "description": "Deletes a page or page element from the presentation.",
- "$ref": "DeleteObjectRequest"
- },
- "updateParagraphStyle": {
- "$ref": "UpdateParagraphStyleRequest",
- "description": "Updates the styling of paragraphs within a Shape or Table."
- },
- "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": {
- "description": "Creates a video.",
- "$ref": "CreateVideoRequest"
- },
- "createSheetsChart": {
- "description": "Creates an embedded Google Sheets chart.",
- "$ref": "CreateSheetsChartRequest"
- },
- "replaceAllShapesWithSheetsChart": {
- "$ref": "ReplaceAllShapesWithSheetsChartRequest",
- "description": "Replaces all shapes matching some criteria with a Google Sheets chart."
- },
- "updatePageElementTransform": {
- "description": "Updates the transform of a page element.",
- "$ref": "UpdatePageElementTransformRequest"
- },
- "updateTextStyle": {
- "description": "Updates the styling of text within a Shape or Table.",
- "$ref": "UpdateTextStyleRequest"
- }
- },
- "id": "Request"
- },
- "UpdateImagePropertiesRequest": {
- "description": "Update the properties of an Image.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the image the updates are applied to.",
- "type": "string"
- },
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "imageProperties": {
- "description": "The image properties to update.",
- "$ref": "ImageProperties"
- }
- },
- "id": "UpdateImagePropertiesRequest"
- },
- "ParagraphStyle": {
- "properties": {
- "spaceBelow": {
- "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
- "$ref": "Dimension"
- },
- "direction": {
- "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT\nsince text 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"
- ]
- },
- "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": {
- "enumDescriptions": [
- "The spacing mode is inherited from the parent.",
- "Paragraph spacing is always rendered.",
- "Paragraph spacing is skipped between list elements."
- ],
- "enum": [
- "SPACING_MODE_UNSPECIFIED",
- "NEVER_COLLAPSE",
- "COLLAPSE_LISTS"
- ],
- "description": "The spacing mode for the paragraph.",
- "type": "string"
- },
- "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": {
- "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent.",
- "$ref": "Dimension"
- },
- "lineSpacing": {
- "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
- "format": "float",
- "type": "number"
- },
- "alignment": {
- "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."
- ],
- "enum": [
- "ALIGNMENT_UNSPECIFIED",
- "START",
- "CENTER",
- "END",
- "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.",
- "type": "object"
- },
- "ReplaceAllShapesWithSheetsChartResponse": {
- "description": "The result of replacing shapes with a Google Sheets chart.",
- "type": "object",
- "properties": {
- "occurrencesChanged": {
- "description": "The number of shapes replaced with charts.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "ReplaceAllShapesWithSheetsChartResponse"
- },
- "TableCellProperties": {
- "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",
- "description": "The properties of the TableCell.",
- "type": "object"
- },
- "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": {
- "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."
- ]
- },
- "outlineFill": {
- "description": "The fill of the outline.",
- "$ref": "OutlineFill"
- },
- "weight": {
- "$ref": "Dimension",
- "description": "The thickness of the outline."
- },
- "dashStyle": {
- "description": "The dash style of the outline.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified dash style.",
- "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
- "Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'.",
- "Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'.",
- "Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'dashDot'.",
- "Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal\nvalue 'lgDash'.",
- "Alternating large dashes and dots. Corresponds to ECMA-376\nST_PresetLineDashVal value 'lgDashDot'."
- ],
- "enum": [
- "DASH_STYLE_UNSPECIFIED",
- "SOLID",
- "DOT",
- "DASH",
- "DASH_DOT",
- "LONG_DASH",
- "LONG_DASH_DOT"
- ]
- }
- },
- "id": "Outline"
- },
- "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"
- },
- "TableColumnProperties": {
- "description": "Properties of each column in a table.",
- "type": "object",
- "properties": {
- "columnWidth": {
- "$ref": "Dimension",
- "description": "Width of a column."
- }
- },
- "id": "TableColumnProperties"
- },
- "ShapeProperties": {
- "properties": {
- "outline": {
- "$ref": "Outline",
- "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor."
- },
- "shapeBackgroundFill": {
- "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor.",
- "$ref": "ShapeBackgroundFill"
- },
- "shadow": {
- "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only.",
- "$ref": "Shadow"
- },
- "link": {
- "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders.",
- "$ref": "Link"
- }
- },
- "id": "ShapeProperties",
- "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"
- },
- "NotesProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
- "type": "object",
- "properties": {
- "speakerNotesObjectId": {
- "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
- "type": "string"
- }
- },
- "id": "NotesProperties"
- },
- "TableRow": {
- "properties": {
- "rowHeight": {
- "$ref": "Dimension",
- "description": "Height of a row."
- },
- "tableCells": {
- "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
- "type": "array",
- "items": {
- "$ref": "TableCell"
- }
- }
- },
- "id": "TableRow",
- "description": "Properties and contents of each row in a table.",
- "type": "object"
- },
- "UpdateTableCellPropertiesRequest": {
- "description": "Update the properties of a TableCell.",
- "type": "object",
- "properties": {
- "fields": {
- "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "objectId": {
- "description": "The object ID of the table.",
- "type": "string"
- },
- "tableRange": {
- "$ref": "TableRange",
- "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
- },
- "tableCellProperties": {
- "$ref": "TableCellProperties",
- "description": "The table cell properties to update."
- }
- },
- "id": "UpdateTableCellPropertiesRequest"
- },
- "CreateSlideRequest": {
- "description": "Creates a new slide.",
- "type": "object",
- "properties": {
- "placeholderIdMappings": {
- "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
- "type": "array",
- "items": {
- "$ref": "LayoutPlaceholderIdMapping"
- }
- },
- "slideLayoutReference": {
- "$ref": "LayoutReference",
- "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
- },
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "insertionIndex": {
- "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CreateSlideRequest"
- },
- "BatchUpdatePresentationRequest": {
- "id": "BatchUpdatePresentationRequest",
- "description": "Request message for PresentationsService.BatchUpdatePresentation.",
- "type": "object",
- "properties": {
- "requests": {
- "description": "A list of updates to apply to the presentation.",
- "type": "array",
- "items": {
- "$ref": "Request"
- }
- },
- "writeControl": {
- "$ref": "WriteControl",
- "description": "Provides control over how write requests are executed, such as\nconditionally updating the presentation."
- }
- }
- },
- "TextContent": {
- "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.",
- "type": "object",
- "properties": {
- "textElements": {
- "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only.",
- "type": "array",
- "items": {
- "$ref": "TextElement"
- }
- },
- "lists": {
- "additionalProperties": {
- "$ref": "List"
- },
- "description": "The bulleted lists contained in this text, keyed by list ID.",
- "type": "object"
- }
- },
- "id": "TextContent"
- },
- "CreateSheetsChartResponse": {
- "description": "The result of creating an embedded Google Sheets chart.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created chart.",
- "type": "string"
- }
- },
- "id": "CreateSheetsChartResponse"
- },
- "WriteControl": {
- "description": "Provides control over how write requests are executed.",
- "type": "object",
- "properties": {
- "requiredRevisionId": {
- "type": "string",
- "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error."
- }
- },
- "id": "WriteControl"
- },
- "DeleteParagraphBulletsRequest": {
- "description": "Deletes bullets from all of the paragraphs that overlap with the given text\nindex range.\n\nThe nesting level of each paragraph will be visually preserved by adding\nindent to the start of the corresponding paragraph.",
- "type": "object",
- "properties": {
- "cellLocation": {
- "$ref": "TableCellLocation",
- "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table."
- },
- "objectId": {
- "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
- "type": "string"
- },
- "textRange": {
- "$ref": "Range",
- "description": "The range of text to delete bullets from, based on TextElement indexes."
- }
- },
- "id": "DeleteParagraphBulletsRequest"
- },
"ParagraphMarker": {
"description": "A TextElement kind that represents the beginning of a new paragraph.",
"type": "object",
"properties": {
"style": {
- "description": "The paragraph's style",
- "$ref": "ParagraphStyle"
+ "$ref": "ParagraphStyle",
+ "description": "The paragraph's style"
},
"bullet": {
"description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list.",
@@ -1156,6 +270,7 @@
"id": "ParagraphMarker"
},
"InsertTableColumnsRequest": {
+ "type": "object",
"properties": {
"number": {
"description": "The number of columns to be inserted. Maximum 20 per request.",
@@ -1167,8 +282,8 @@
"description": "The reference table cell location from which columns will be inserted.\n\nA new column will be inserted to the left (or right) of the column where\nthe reference cell is. If the reference cell is a merged cell, a new\ncolumn will be inserted to the left (or right) of the merged cell."
},
"insertRight": {
- "description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left.",
- "type": "boolean"
+ "type": "boolean",
+ "description": "Whether to insert new columns to the right of the reference cell location.\n\n- `True`: insert to the right.\n- `False`: insert to the left."
},
"tableObjectId": {
"description": "The table to insert columns into.",
@@ -1176,11 +291,9 @@
}
},
"id": "InsertTableColumnsRequest",
- "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.",
- "type": "object"
+ "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column."
},
"LayoutPlaceholderIdMapping": {
- "id": "LayoutPlaceholderIdMapping",
"description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.",
"type": "object",
"properties": {
@@ -1193,18 +306,16 @@
"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"
+ "type": "string",
+ "description": "The object ID of the placeholder on a layout that will be applied\nto a slide."
}
- }
+ },
+ "id": "LayoutPlaceholderIdMapping"
},
"UpdateShapePropertiesRequest": {
+ "description": "Update the properties of a Shape.",
"type": "object",
"properties": {
- "objectId": {
- "description": "The object ID of the shape the updates are applied to.",
- "type": "string"
- },
"shapeProperties": {
"$ref": "ShapeProperties",
"description": "The shape properties to update."
@@ -1213,21 +324,24 @@
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the shape the updates are applied to.",
+ "type": "string"
}
},
- "id": "UpdateShapePropertiesRequest",
- "description": "Update the properties of a Shape."
+ "id": "UpdateShapePropertiesRequest"
},
"WordArt": {
- "description": "A PageElement kind representing\nword art.",
- "type": "object",
"properties": {
"renderedText": {
"description": "The text rendered as word art.",
"type": "string"
}
},
- "id": "WordArt"
+ "id": "WordArt",
+ "description": "A PageElement kind representing\nword art.",
+ "type": "object"
},
"Recolor": {
"properties": {
@@ -1239,33 +353,6 @@
}
},
"name": {
- "enum": [
- "NONE",
- "LIGHT1",
- "LIGHT2",
- "LIGHT3",
- "LIGHT4",
- "LIGHT5",
- "LIGHT6",
- "LIGHT7",
- "LIGHT8",
- "LIGHT9",
- "LIGHT10",
- "DARK1",
- "DARK2",
- "DARK3",
- "DARK4",
- "DARK5",
- "DARK6",
- "DARK7",
- "DARK8",
- "DARK9",
- "DARK10",
- "GRAYSCALE",
- "NEGATIVE",
- "SEPIA",
- "CUSTOM"
- ],
"description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.",
"type": "string",
"enumDescriptions": [
@@ -1294,6 +381,33 @@
"A recolor effect that recolors the image to negative grayscale.",
"A recolor effect that recolors the image using the sepia color.",
"Custom recolor effect. Refer to `recolor_stops` for the concrete\ngradient."
+ ],
+ "enum": [
+ "NONE",
+ "LIGHT1",
+ "LIGHT2",
+ "LIGHT3",
+ "LIGHT4",
+ "LIGHT5",
+ "LIGHT6",
+ "LIGHT7",
+ "LIGHT8",
+ "LIGHT9",
+ "LIGHT10",
+ "DARK1",
+ "DARK2",
+ "DARK3",
+ "DARK4",
+ "DARK5",
+ "DARK6",
+ "DARK7",
+ "DARK8",
+ "DARK9",
+ "DARK10",
+ "GRAYSCALE",
+ "NEGATIVE",
+ "SEPIA",
+ "CUSTOM"
]
}
},
@@ -1302,6 +416,8 @@
"type": "object"
},
"Link": {
+ "description": "A hypertext link.",
+ "type": "object",
"properties": {
"pageObjectId": {
"description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.",
@@ -1312,6 +428,13 @@
"type": "string"
},
"relativeLink": {
+ "enum": [
+ "RELATIVE_SLIDE_LINK_UNSPECIFIED",
+ "NEXT_SLIDE",
+ "PREVIOUS_SLIDE",
+ "FIRST_SLIDE",
+ "LAST_SLIDE"
+ ],
"description": "If set, indicates this is a link to a slide in this presentation,\naddressed by its position.",
"type": "string",
"enumDescriptions": [
@@ -1320,13 +443,6 @@
"A link to the previous slide.",
"A link to the first slide in the presentation.",
"A link to the last slide in the presentation."
- ],
- "enum": [
- "RELATIVE_SLIDE_LINK_UNSPECIFIED",
- "NEXT_SLIDE",
- "PREVIOUS_SLIDE",
- "FIRST_SLIDE",
- "LAST_SLIDE"
]
},
"slideIndex": {
@@ -1335,11 +451,10 @@
"type": "integer"
}
},
- "id": "Link",
- "description": "A hypertext link.",
- "type": "object"
+ "id": "Link"
},
"RgbColor": {
+ "description": "An RGB color.",
"type": "object",
"properties": {
"red": {
@@ -1358,30 +473,26 @@
"type": "number"
}
},
- "id": "RgbColor",
- "description": "An RGB color."
+ "id": "RgbColor"
},
"CreateShapeResponse": {
+ "description": "The result of creating a shape.",
+ "type": "object",
"properties": {
"objectId": {
"description": "The object ID of the created shape.",
"type": "string"
}
},
- "id": "CreateShapeResponse",
- "description": "The result of creating a shape.",
- "type": "object"
+ "id": "CreateShapeResponse"
},
"CreateLineRequest": {
- "type": "object",
"properties": {
"elementProperties": {
"$ref": "PageElementProperties",
"description": "The element properties for the line."
},
"lineCategory": {
- "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.",
@@ -1391,7 +502,9 @@
"STRAIGHT",
"BENT",
"CURVED"
- ]
+ ],
+ "description": "The category of line to be created.",
+ "type": "string"
},
"objectId": {
"description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
@@ -1399,21 +512,21 @@
}
},
"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",
- "description": "The result of creating a slide.",
- "type": "object"
+ "id": "CreateSlideResponse"
},
"CreateShapeRequest": {
- "description": "Creates a new shape.",
"type": "object",
"properties": {
"objectId": {
@@ -1421,6 +534,7 @@
"type": "string"
},
"shapeType": {
+ "type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
"Text box shape.",
@@ -1711,30 +825,19 @@
"CLOUD_CALLOUT",
"CUSTOM"
],
- "description": "The shape type.",
- "type": "string"
+ "description": "The shape type."
},
"elementProperties": {
"$ref": "PageElementProperties",
"description": "The element properties for the shape."
}
},
- "id": "CreateShapeRequest"
+ "id": "CreateShapeRequest",
+ "description": "Creates a new shape."
},
"Video": {
+ "type": "object",
"properties": {
- "source": {
- "enumDescriptions": [
- "The video source is unspecified.",
- "The video source is YouTube."
- ],
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
- "description": "The video source.",
- "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"
@@ -1746,11 +849,22 @@
"videoProperties": {
"$ref": "VideoProperties",
"description": "The properties of the video."
+ },
+ "source": {
+ "description": "The video source.",
+ "type": "string",
+ "enumDescriptions": [
+ "The video source is unspecified.",
+ "The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
+ ]
}
},
"id": "Video",
- "description": "A PageElement kind representing a\nvideo.",
- "type": "object"
+ "description": "A PageElement kind representing a\nvideo."
},
"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.",
@@ -1761,25 +875,32 @@
"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": {
- "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"
+ "$ref": "PageBackgroundFill",
+ "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor."
}
},
"id": "PageProperties"
},
"NestingLevel": {
+ "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting.",
"type": "object",
"properties": {
"bulletStyle": {
- "$ref": "TextStyle",
- "description": "The style of a bullet at this level of nesting."
+ "description": "The style of a bullet at this level of nesting.",
+ "$ref": "TextStyle"
}
},
- "id": "NestingLevel",
- "description": "Contains properties describing the look and feel of a list bullet at a given\nlevel of nesting."
+ "id": "NestingLevel"
},
"TableCell": {
+ "id": "TableCell",
+ "description": "Properties and contents of each table cell.",
+ "type": "object",
"properties": {
+ "tableCellProperties": {
+ "$ref": "TableCellProperties",
+ "description": "The properties of the table cell."
+ },
"location": {
"description": "The location of the cell within the table.",
"$ref": "TableCellLocation"
@@ -1790,31 +911,20 @@
"type": "integer"
},
"columnSpan": {
- "type": "integer",
"description": "Column span of the cell.",
- "format": "int32"
+ "format": "int32",
+ "type": "integer"
},
"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.",
- "type": "object"
+ }
},
"UpdateLinePropertiesRequest": {
"description": "Updates the properties of a Line.",
"type": "object",
"properties": {
- "objectId": {
- "description": "The object ID of the line the update is applied to.",
- "type": "string"
- },
"lineProperties": {
"$ref": "LineProperties",
"description": "The line properties to update."
@@ -1823,34 +933,20 @@
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the line the update is applied to.",
+ "type": "string"
}
},
"id": "UpdateLinePropertiesRequest"
},
- "UpdateSlidesPositionRequest": {
- "description": "Updates the position of slides in the presentation.",
- "type": "object",
- "properties": {
- "insertionIndex": {
- "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
- "format": "int32",
- "type": "integer"
- },
- "slideObjectIds": {
- "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "UpdateSlidesPositionRequest"
- },
"TableCellBackgroundFill": {
- "id": "TableCellBackgroundFill",
- "description": "The table cell background fill.",
- "type": "object",
"properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ },
"propertyState": {
"enumDescriptions": [
"If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
@@ -1864,29 +960,47 @@
],
"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"
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
}
- }
+ },
+ "id": "TableCellBackgroundFill",
+ "description": "The table cell background fill.",
+ "type": "object"
+ },
+ "UpdateSlidesPositionRequest": {
+ "description": "Updates the position of slides in the presentation.",
+ "type": "object",
+ "properties": {
+ "slideObjectIds": {
+ "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "insertionIndex": {
+ "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "UpdateSlidesPositionRequest"
},
"UpdatePagePropertiesRequest": {
"description": "Updates the properties of a Page.",
"type": "object",
"properties": {
- "objectId": {
- "type": "string",
- "description": "The object ID of the page the update is applied to."
- },
- "pageProperties": {
- "$ref": "PageProperties",
- "description": "The page properties to update."
- },
"fields": {
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the page the update is applied to.",
+ "type": "string"
+ },
+ "pageProperties": {
+ "$ref": "PageProperties",
+ "description": "The page properties to update."
}
},
"id": "UpdatePagePropertiesRequest"
@@ -1906,10 +1020,17 @@
"id": "Group"
},
"Placeholder": {
- "id": "Placeholder",
- "description": "The placeholder information that uniquely identifies a placeholder shape.",
"type": "object",
"properties": {
+ "parentObjectId": {
+ "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.",
+ "type": "string"
+ },
+ "index": {
+ "description": "The index of the placeholder. If the same placeholder types are the present\nin the same page, they would have different index values.",
+ "format": "int32",
+ "type": "integer"
+ },
"type": {
"enumDescriptions": [
"Default value, signifies it is not a placeholder.",
@@ -1951,17 +1072,10 @@
],
"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": {
- "description": "The index of the placeholder. If the same placeholder types are the present\nin the same page, they would have different index values.",
- "format": "int32",
- "type": "integer"
}
- }
+ },
+ "id": "Placeholder",
+ "description": "The placeholder information that uniquely identifies a placeholder shape."
},
"DuplicateObjectRequest": {
"properties": {
@@ -1982,6 +1096,7 @@
"type": "object"
},
"ReplaceAllTextRequest": {
+ "description": "Replaces all instances of text matching a criteria with replace text.",
"type": "object",
"properties": {
"replaceText": {
@@ -1993,10 +1108,10 @@
"$ref": "SubstringMatchCriteria"
}
},
- "id": "ReplaceAllTextRequest",
- "description": "Replaces all instances of text matching a criteria with replace text."
+ "id": "ReplaceAllTextRequest"
},
"Page": {
+ "id": "Page",
"description": "A page in a presentation.",
"type": "object",
"properties": {
@@ -2012,11 +1127,14 @@
"$ref": "LayoutProperties",
"description": "Layout specific properties. Only set if page_type = LAYOUT."
},
- "notesProperties": {
- "$ref": "NotesProperties",
- "description": "Notes specific properties. Only set if page_type = NOTES."
- },
"pageType": {
+ "enum": [
+ "SLIDE",
+ "MASTER",
+ "LAYOUT",
+ "NOTES",
+ "NOTES_MASTER"
+ ],
"description": "The type of the page.",
"type": "string",
"enumDescriptions": [
@@ -2025,13 +1143,6 @@
"A layout page.",
"A notes page.",
"A notes master page."
- ],
- "enum": [
- "SLIDE",
- "MASTER",
- "LAYOUT",
- "NOTES",
- "NOTES_MASTER"
]
},
"pageElements": {
@@ -2041,6 +1152,10 @@
"$ref": "PageElement"
}
},
+ "notesProperties": {
+ "description": "Notes specific properties. Only set if page_type = NOTES.",
+ "$ref": "NotesProperties"
+ },
"slideProperties": {
"$ref": "SlideProperties",
"description": "Slide specific properties. Only set if page_type = SLIDE."
@@ -2049,11 +1164,16 @@
"$ref": "PageProperties",
"description": "The properties of the page."
}
- },
- "id": "Page"
+ }
},
"ShapeBackgroundFill": {
+ "description": "The shape background fill.",
+ "type": "object",
"properties": {
+ "solidFill": {
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
+ },
"propertyState": {
"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",
@@ -2067,19 +1187,23 @@
"NOT_RENDERED",
"INHERIT"
]
- },
- "solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
}
},
- "id": "ShapeBackgroundFill",
- "description": "The shape background fill.",
- "type": "object"
+ "id": "ShapeBackgroundFill"
},
"CropProperties": {
"type": "object",
"properties": {
+ "bottomOffset": {
+ "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
+ "format": "float",
+ "type": "number"
+ },
+ "angle": {
+ "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
+ "format": "float",
+ "type": "number"
+ },
"topOffset": {
"description": "The offset specifies the top edge of the crop rectangle that is located\nbelow the original bounding rectangle top edge, relative to the object's\noriginal height.",
"format": "float",
@@ -2094,16 +1218,6 @@
"description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.",
"format": "float",
"type": "number"
- },
- "bottomOffset": {
- "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.",
- "format": "float",
- "type": "number"
- },
- "angle": {
- "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.",
- "format": "float",
- "type": "number"
}
},
"id": "CropProperties",
@@ -2118,7 +1232,6 @@
"type": "string"
},
"linkingMode": {
- "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.",
@@ -2127,7 +1240,8 @@
"enum": [
"NOT_LINKED_IMAGE",
"LINKED"
- ]
+ ],
+ "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked."
},
"containsText": {
"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.",
@@ -2156,31 +1270,14 @@
"type": "number"
},
"color": {
- "description": "The color of the gradient stop.",
- "$ref": "OpaqueColor"
+ "$ref": "OpaqueColor",
+ "description": "The color of the gradient stop."
}
},
"id": "ColorStop"
},
"Range": {
- "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."
- },
"startIndex": {
"description": "The optional zero-based index of the beginning of the collection.\nRequired for `SPECIFIC_RANGE` and `FROM_START_INDEX` ranges.",
"format": "int32",
@@ -2190,63 +1287,75 @@
"description": "The optional zero-based index of the end of the collection.\nRequired for `SPECIFIC_RANGE` delete mode.",
"format": "int32",
"type": "integer"
+ },
+ "type": {
+ "enum": [
+ "RANGE_TYPE_UNSPECIFIED",
+ "FIXED_RANGE",
+ "FROM_START_INDEX",
+ "ALL"
+ ],
+ "description": "The type of range.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified range type. This value must not be used.",
+ "A fixed range. Both the `start_index` and\n`end_index` must be specified.",
+ "Starts the range at `start_index` and continues until the\nend of the collection. The `end_index` must not be specified.",
+ "Sets the range to be the whole length of the collection. Both the\n`start_index` and the `end_index` must not be\nspecified."
+ ]
}
},
"id": "Range",
- "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext."
+ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.",
+ "type": "object"
},
"CreateVideoRequest": {
- "description": "Creates a video.",
"type": "object",
"properties": {
+ "id": {
+ "description": "The video source's unique identifier for this video.\n\ne.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,\nthe ID is 7U3axjORYZ0.",
+ "type": "string"
+ },
"objectId": {
"description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
"type": "string"
},
"source": {
- "enum": [
- "SOURCE_UNSPECIFIED",
- "YOUTUBE"
- ],
"description": "The video source.",
"type": "string",
"enumDescriptions": [
"The video source is unspecified.",
"The video source is YouTube."
+ ],
+ "enum": [
+ "SOURCE_UNSPECIFIED",
+ "YOUTUBE"
]
},
"elementProperties": {
- "description": "The element properties for the video.",
- "$ref": "PageElementProperties"
- },
- "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"
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the video."
}
},
- "id": "CreateVideoRequest"
+ "id": "CreateVideoRequest",
+ "description": "Creates a video."
},
"DuplicateObjectResponse": {
- "description": "The response of duplicating an object.",
- "type": "object",
"properties": {
"objectId": {
"description": "The ID of the new duplicate object.",
"type": "string"
}
},
- "id": "DuplicateObjectResponse"
+ "id": "DuplicateObjectResponse",
+ "description": "The response of duplicating an object.",
+ "type": "object"
},
"ReplaceAllShapesWithImageRequest": {
"description": "Replaces all shapes that match the given criteria with the provided image.",
"type": "object",
"properties": {
- "imageUrl": {
- "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
- "type": "string"
- },
"replaceMethod": {
- "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.",
@@ -2255,17 +1364,69 @@
"enum": [
"CENTER_INSIDE",
"CENTER_CROP"
- ]
+ ],
+ "description": "The replace method."
},
"containsText": {
- "$ref": "SubstringMatchCriteria",
- "description": "If set, this request will replace all of the shapes that contain the\ngiven text."
+ "description": "If set, this request will replace all of the shapes that contain the\ngiven text.",
+ "$ref": "SubstringMatchCriteria"
+ },
+ "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."
}
},
"id": "ReplaceAllShapesWithImageRequest"
},
"Shadow": {
"properties": {
+ "alpha": {
+ "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
+ "format": "float",
+ "type": "number"
+ },
+ "color": {
+ "$ref": "OpaqueColor",
+ "description": "The shadow color value."
+ },
+ "rotateWithShape": {
+ "description": "Whether the shadow should rotate with the shape.",
+ "type": "boolean"
+ },
+ "propertyState": {
+ "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": {
+ "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes.",
+ "$ref": "Dimension"
+ },
+ "transform": {
+ "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position.",
+ "$ref": "AffineTransform"
+ },
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified shadow type.",
+ "Outer shadow."
+ ],
+ "enum": [
+ "SHADOW_TYPE_UNSPECIFIED",
+ "OUTER"
+ ],
+ "description": "The type of the shadow."
+ },
"alignment": {
"description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.",
"type": "string",
@@ -2293,53 +1454,6 @@
"BOTTOM_CENTER",
"BOTTOM_RIGHT"
]
- },
- "alpha": {
- "description": "The alpha of the shadow's color, from 0.0 to 1.0.",
- "format": "float",
- "type": "number"
- },
- "color": {
- "$ref": "OpaqueColor",
- "description": "The shadow color value."
- },
- "rotateWithShape": {
- "description": "Whether the shadow should rotate with the shape.",
- "type": "boolean"
- },
- "propertyState": {
- "enum": [
- "RENDERED",
- "NOT_RENDERED",
- "INHERIT"
- ],
- "description": "The shadow property state.\n\nUpdating the 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."
- },
- "transform": {
- "$ref": "AffineTransform",
- "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position."
- },
- "type": {
- "enum": [
- "SHADOW_TYPE_UNSPECIFIED",
- "OUTER"
- ],
- "description": "The type of the shadow.",
- "type": "string",
- "enumDescriptions": [
- "Unspecified shadow type.",
- "Outer shadow."
- ]
}
},
"id": "Shadow",
@@ -2350,20 +1464,18 @@
"description": "Deletes a row from a table.",
"type": "object",
"properties": {
- "cellLocation": {
- "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted.",
- "$ref": "TableCellLocation"
- },
"tableObjectId": {
- "description": "The table to delete rows from.",
- "type": "string"
+ "type": "string",
+ "description": "The table to delete rows from."
+ },
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted."
}
},
"id": "DeleteTableRowRequest"
},
"Bullet": {
- "description": "Describes the bullet of a paragraph.",
- "type": "object",
"properties": {
"nestingLevel": {
"description": "The nesting level of this paragraph in the list.",
@@ -2371,8 +1483,8 @@
"type": "integer"
},
"bulletStyle": {
- "description": "The paragraph specific text style applied to this bullet.",
- "$ref": "TextStyle"
+ "$ref": "TextStyle",
+ "description": "The paragraph specific text style applied to this bullet."
},
"listId": {
"description": "The ID of the list this paragraph belongs to.",
@@ -2383,30 +1495,21 @@
"type": "string"
}
},
- "id": "Bullet"
+ "id": "Bullet",
+ "description": "Describes the bullet of a paragraph.",
+ "type": "object"
},
"OutlineFill": {
"description": "The fill of the outline.",
"type": "object",
"properties": {
"solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
}
},
"id": "OutlineFill"
},
- "CreateLineResponse": {
- "description": "The result of creating a line.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "The object ID of the created line.",
- "type": "string"
- }
- },
- "id": "CreateLineResponse"
- },
"TableCellLocation": {
"description": "A location of a single table cell within a table.",
"type": "object",
@@ -2424,28 +1527,31 @@
},
"id": "TableCellLocation"
},
- "ReplaceAllTextResponse": {
- "description": "The result of replacing text.",
+ "CreateLineResponse": {
"type": "object",
"properties": {
+ "objectId": {
+ "type": "string",
+ "description": "The object ID of the created line."
+ }
+ },
+ "id": "CreateLineResponse",
+ "description": "The result of creating a line."
+ },
+ "ReplaceAllTextResponse": {
+ "properties": {
"occurrencesChanged": {
"description": "The number of occurrences changed by replacing all text.",
"format": "int32",
"type": "integer"
}
},
- "id": "ReplaceAllTextResponse"
+ "id": "ReplaceAllTextResponse",
+ "description": "The result of replacing text.",
+ "type": "object"
},
"UpdateParagraphStyleRequest": {
"properties": {
- "objectId": {
- "description": "The object ID of the shape or table with the text to be styled.",
- "type": "string"
- },
- "textRange": {
- "description": "The range of text containing the paragraph(s) to style.",
- "$ref": "Range"
- },
"cellLocation": {
"description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.",
"$ref": "TableCellLocation"
@@ -2458,6 +1564,14 @@
"description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
"format": "google-fieldmask",
"type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ },
+ "textRange": {
+ "description": "The range of text containing the paragraph(s) to style.",
+ "$ref": "Range"
}
},
"id": "UpdateParagraphStyleRequest",
@@ -2465,6 +1579,8 @@
"type": "object"
},
"ColorScheme": {
+ "description": "The palette of predefined colors for a page.",
+ "type": "object",
"properties": {
"colors": {
"description": "The ThemeColorType and corresponding concrete color pairs.",
@@ -2474,15 +1590,15 @@
}
}
},
- "id": "ColorScheme",
- "description": "The palette of predefined colors for a page.",
- "type": "object"
+ "id": "ColorScheme"
},
"Shape": {
"description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.",
"type": "object",
"properties": {
"shapeType": {
+ "description": "The type of the shape.",
+ "type": "string",
"enumDescriptions": [
"The shape type that is not predefined.",
"Text box shape.",
@@ -2772,44 +1888,72 @@
"ELLIPSE_RIBBON_2",
"CLOUD_CALLOUT",
"CUSTOM"
- ],
- "description": "The type of the shape.",
- "type": "string"
+ ]
},
"text": {
- "description": "The text content of the shape.",
- "$ref": "TextContent"
+ "$ref": "TextContent",
+ "description": "The text content of the shape."
},
"placeholder": {
- "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field.",
- "$ref": "Placeholder"
+ "$ref": "Placeholder",
+ "description": "Placeholders are shapes that are inherit from corresponding placeholders on\nlayouts and masters.\n\nIf set, the shape is a placeholder shape and any inherited properties\ncan be resolved by looking at the parent placeholder identified by the\nPlaceholder.parent_object_id field."
},
"shapeProperties": {
- "$ref": "ShapeProperties",
- "description": "The properties of the shape."
+ "description": "The properties of the shape.",
+ "$ref": "ShapeProperties"
}
},
"id": "Shape"
},
"Image": {
+ "description": "A PageElement kind representing an\nimage.",
+ "type": "object",
"properties": {
"imageProperties": {
- "description": "The properties of the image.",
- "$ref": "ImageProperties"
+ "$ref": "ImageProperties",
+ "description": "The properties of the image."
},
"contentUrl": {
- "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.",
- "type": "string"
+ "type": "string",
+ "description": "An URL to an image with a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change."
}
},
- "id": "Image",
- "description": "A PageElement kind representing an\nimage.",
- "type": "object"
+ "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": {
+ "scaleX": {
+ "type": "number",
+ "description": "The X coordinate scaling element.",
+ "format": "double"
+ },
+ "shearX": {
+ "description": "The X coordinate shearing element.",
+ "format": "double",
+ "type": "number"
+ },
+ "scaleY": {
+ "description": "The Y coordinate scaling element.",
+ "format": "double",
+ "type": "number"
+ },
+ "translateY": {
+ "type": "number",
+ "description": "The Y coordinate translation element.",
+ "format": "double"
+ },
+ "translateX": {
+ "description": "The X coordinate translation element.",
+ "format": "double",
+ "type": "number"
+ },
+ "shearY": {
+ "description": "The Y coordinate shearing element.",
+ "format": "double",
+ "type": "number"
+ },
"unit": {
"enum": [
"UNIT_UNSPECIFIED",
@@ -2823,41 +1967,12 @@
"An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.",
"A point, 1/72 of an inch."
]
- },
- "scaleX": {
- "description": "The X coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "shearX": {
- "description": "The X coordinate shearing element.",
- "format": "double",
- "type": "number"
- },
- "scaleY": {
- "description": "The Y coordinate scaling element.",
- "format": "double",
- "type": "number"
- },
- "translateY": {
- "description": "The Y coordinate translation element.",
- "format": "double",
- "type": "number"
- },
- "translateX": {
- "description": "The X coordinate translation element.",
- "format": "double",
- "type": "number"
- },
- "shearY": {
- "description": "The Y coordinate shearing element.",
- "format": "double",
- "type": "number"
}
},
"id": "AffineTransform"
},
"InsertTextRequest": {
+ "description": "Inserts text into a shape or a table cell.",
"type": "object",
"properties": {
"objectId": {
@@ -2874,16 +1989,16 @@
"type": "integer"
},
"cellLocation": {
- "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.",
- "$ref": "TableCellLocation"
+ "$ref": "TableCellLocation",
+ "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table."
}
},
- "id": "InsertTextRequest",
- "description": "Inserts text into a shape or a table cell."
+ "id": "InsertTextRequest"
},
"AutoText": {
"properties": {
"type": {
+ "type": "string",
"enumDescriptions": [
"An unspecified autotext type.",
"Type for autotext that represents the current slide number."
@@ -2892,16 +2007,15 @@
"TYPE_UNSPECIFIED",
"SLIDE_NUMBER"
],
- "description": "The type of this auto text.",
- "type": "string"
+ "description": "The type of this auto text."
},
"content": {
"type": "string",
"description": "The rendered content of this auto text, if available."
},
"style": {
- "description": "The styling applied to this auto text.",
- "$ref": "TextStyle"
+ "$ref": "TextStyle",
+ "description": "The styling applied to this auto text."
}
},
"id": "AutoText",
@@ -2928,10 +2042,12 @@
"type": "string"
},
"transform": {
- "description": "The input transform matrix used to update the page element.",
- "$ref": "AffineTransform"
+ "$ref": "AffineTransform",
+ "description": "The input transform matrix used to update the page element."
},
"applyMode": {
+ "description": "The apply mode of the transform update.",
+ "type": "string",
"enumDescriptions": [
"Unspecified mode.",
"Applies the new AffineTransform matrix to the existing one, and\nreplaces the existing one with the resulting concatenation.",
@@ -2941,15 +2057,12 @@
"APPLY_MODE_UNSPECIFIED",
"RELATIVE",
"ABSOLUTE"
- ],
- "description": "The apply mode of the transform update.",
- "type": "string"
+ ]
}
},
"id": "UpdatePageElementTransformRequest"
},
"DeleteTextRequest": {
- "description": "Deletes text from a shape or a table cell.",
"type": "object",
"properties": {
"objectId": {
@@ -2957,58 +2070,29 @@
"type": "string"
},
"textRange": {
- "$ref": "Range",
- "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units."
+ "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"
},
"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."
+ "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table.",
+ "$ref": "TableCellLocation"
}
},
- "id": "DeleteTextRequest"
+ "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": {
- "type": "string",
- "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted."
+ "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",
- "description": "Deletes an object, either pages or\npage elements, from the\npresentation.",
- "type": "object"
- },
- "TextElement": {
- "properties": {
- "textRun": {
- "$ref": "TextRun",
- "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
- },
- "autoText": {
- "$ref": "AutoText",
- "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
- },
- "paragraphMarker": {
- "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap.",
- "$ref": "ParagraphMarker"
- },
- "startIndex": {
- "description": "The zero-based start index of this text element, in Unicode code units.",
- "format": "int32",
- "type": "integer"
- },
- "endIndex": {
- "type": "integer",
- "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
- "format": "int32"
- }
- },
- "id": "TextElement",
- "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
- "type": "object"
+ "id": "DeleteObjectRequest"
},
"Dimension": {
- "id": "Dimension",
"description": "A magnitude in a single direction in the specified units.",
"type": "object",
"properties": {
@@ -3031,15 +2115,45 @@
"A point, 1/72 of an inch."
]
}
- }
+ },
+ "id": "Dimension"
+ },
+ "TextElement": {
+ "properties": {
+ "textRun": {
+ "$ref": "TextRun",
+ "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs."
+ },
+ "autoText": {
+ "$ref": "AutoText",
+ "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time."
+ },
+ "paragraphMarker": {
+ "$ref": "ParagraphMarker",
+ "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap."
+ },
+ "startIndex": {
+ "description": "The zero-based start index of this text element, in Unicode code units.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "endIndex": {
+ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "TextElement",
+ "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.",
+ "type": "object"
},
"LineFill": {
"description": "The fill of the line.",
"type": "object",
"properties": {
"solidFill": {
- "$ref": "SolidFill",
- "description": "Solid color fill."
+ "description": "Solid color fill.",
+ "$ref": "SolidFill"
}
},
"id": "LineFill"
@@ -3080,34 +2194,37 @@
"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."
+ "description": "The name of the layout.",
+ "type": "string"
},
"displayName": {
"description": "The human readable name of the layout in the presentation's locale.",
"type": "string"
+ },
+ "masterObjectId": {
+ "description": "The object ID of the master that this layout is based on.",
+ "type": "string"
}
},
- "id": "LayoutProperties",
- "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT."
+ "id": "LayoutProperties"
},
"LineProperties": {
"description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor.",
"type": "object",
"properties": {
+ "weight": {
+ "$ref": "Dimension",
+ "description": "The thickness of the line."
+ },
"lineFill": {
- "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.",
- "$ref": "LineFill"
+ "$ref": "LineFill",
+ "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor."
},
"dashStyle": {
- "type": "string",
"enumDescriptions": [
"Unspecified dash style.",
"Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.",
@@ -3126,14 +2243,14 @@
"LONG_DASH",
"LONG_DASH_DOT"
],
- "description": "The dash style of the line."
+ "description": "The dash style of the line.",
+ "type": "string"
},
"link": {
- "description": "The hyperlink destination of the line. If unset, there is no link.",
- "$ref": "Link"
+ "$ref": "Link",
+ "description": "The hyperlink destination of the line. If unset, there is no link."
},
- "endArrow": {
- "type": "string",
+ "startArrow": {
"enumDescriptions": [
"An unspecified arrow style.",
"No arrow.",
@@ -3160,23 +2277,24 @@
"OPEN_SQUARE",
"OPEN_DIAMOND"
],
- "description": "The style of the arrow at the end of the line."
- },
- "startArrow": {
- "enum": [
- "ARROW_STYLE_UNSPECIFIED",
- "NONE",
- "STEALTH_ARROW",
- "FILL_ARROW",
- "FILL_CIRCLE",
- "FILL_SQUARE",
- "FILL_DIAMOND",
- "OPEN_ARROW",
- "OPEN_CIRCLE",
- "OPEN_SQUARE",
- "OPEN_DIAMOND"
- ],
"description": "The style of the arrow at the beginning of the line.",
+ "type": "string"
+ },
+ "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.",
@@ -3191,33 +2309,13 @@
"Hollow square.",
"Hollow diamond."
]
- },
- "weight": {
- "description": "The thickness of the line.",
- "$ref": "Dimension"
}
},
"id": "LineProperties"
},
"Presentation": {
- "description": "A Google Slides presentation.",
"type": "object",
"properties": {
- "presentationId": {
- "type": "string",
- "description": "The ID of the presentation."
- },
- "slides": {
- "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "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. Callers\ncan assume that if two revision IDs are equal then the presentation has not\nchanged.",
- "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."
@@ -3233,10 +2331,6 @@
"description": "The title of the presentation.",
"type": "string"
},
- "locale": {
- "description": "The locale of the presentation, as an IETF BCP 47 language tag.",
- "type": "string"
- },
"masters": {
"description": "The slide masters in the presentation. A slide master contains all common\npage elements and the common properties for a set of layouts. They serve\nthree purposes:\n\n- Placeholder shapes on a master contain the default text styles and shape\n properties of all placeholder shapes on pages that use that master.\n- The master page properties define the common page properties inherited by\n its layouts.\n- Any other shapes on the master slide will appear on all slides using that\n master, regardless of their layout.",
"type": "array",
@@ -3244,12 +2338,32 @@
"$ref": "Page"
}
},
+ "locale": {
+ "type": "string",
+ "description": "The locale of the presentation, as an IETF BCP 47 language tag."
+ },
"pageSize": {
"description": "The size of pages in the presentation.",
"$ref": "Size"
+ },
+ "presentationId": {
+ "description": "The ID of the presentation.",
+ "type": "string"
+ },
+ "slides": {
+ "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "revisionId": {
+ "type": "string",
+ "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. Callers\ncan assume that if two revision IDs are equal then the presentation has not\nchanged."
}
},
- "id": "Presentation"
+ "id": "Presentation",
+ "description": "A Google Slides presentation."
},
"OpaqueColor": {
"description": "A themeable solid color value.",
@@ -3260,26 +2374,6 @@
"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",
@@ -3299,70 +2393,92 @@
"TEXT2",
"BACKGROUND2"
],
- "description": "An opaque theme color."
+ "description": "An opaque theme color.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ]
}
},
"id": "OpaqueColor"
},
"ImageProperties": {
+ "id": "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": {
- "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
- "format": "float",
- "type": "number"
- },
"transparency": {
"description": "The transparency effect of the image. The value should be in the interval\n[0.0, 1.0], where 0 means no effect and 1 means completely transparent.\nThis property is read-only.",
"format": "float",
"type": "number"
},
"shadow": {
- "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only.",
- "$ref": "Shadow"
+ "$ref": "Shadow",
+ "description": "The shadow of the image. If not set, the image has no shadow. This property\nis read-only."
+ },
+ "link": {
+ "$ref": "Link",
+ "description": "The hyperlink destination of the image. If unset, there is no link."
},
"contrast": {
"description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
"format": "float",
"type": "number"
},
- "link": {
- "$ref": "Link",
- "description": "The hyperlink destination of the image. If unset, there is no link."
- },
"cropProperties": {
"description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only.",
"$ref": "CropProperties"
},
"recolor": {
- "$ref": "Recolor",
- "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only."
+ "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only.",
+ "$ref": "Recolor"
+ },
+ "outline": {
+ "$ref": "Outline",
+ "description": "The outline of the image. If not set, the the image has no outline."
+ },
+ "brightness": {
+ "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.",
+ "format": "float",
+ "type": "number"
}
- },
- "id": "ImageProperties"
+ }
},
"ReplaceAllShapesWithImageResponse": {
- "properties": {
- "occurrencesChanged": {
- "type": "integer",
- "description": "The number of shapes replaced with images.",
- "format": "int32"
- }
- },
"id": "ReplaceAllShapesWithImageResponse",
"description": "The result of replacing shapes with an image.",
- "type": "object"
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "description": "The number of shapes replaced with images.",
+ "format": "int32",
+ "type": "integer"
+ }
+ }
},
"Line": {
"description": "A PageElement kind representing a\nline, curved connector, or bent connector.",
"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'.",
@@ -3386,9 +2502,7 @@
"CURVED_CONNECTOR_3",
"CURVED_CONNECTOR_4",
"CURVED_CONNECTOR_5"
- ],
- "description": "The type of the line.",
- "type": "string"
+ ]
},
"lineProperties": {
"$ref": "LineProperties",
@@ -3406,11 +2520,11 @@
"type": "string"
},
"replies": {
+ "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.",
"type": "array",
"items": {
"$ref": "Response"
- },
- "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty."
+ }
}
},
"id": "BatchUpdatePresentationResponse"
@@ -3463,55 +2577,31 @@
"id": "CreateImageResponse"
},
"SlideProperties": {
- "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
- "type": "object",
"properties": {
+ "notesPage": {
+ "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape.",
+ "$ref": "Page"
+ },
"layoutObjectId": {
- "description": "The object ID of the layout that this slide is based on.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the layout that this slide is based on."
},
"masterObjectId": {
"description": "The object ID of the master that this slide is based on.",
"type": "string"
- },
- "notesPage": {
- "$ref": "Page",
- "description": "The notes page that this slide is associated with. It defines the visual\nappearance of a notes page when printing or exporting slides with speaker\nnotes. A notes page inherits properties from the\nnotes master.\nThe placeholder shape with type BODY on the notes page contains the speaker\nnotes for this slide. The ID of this shape is identified by the\nspeakerNotesObjectId field.\nThe notes page is read-only except for the text content and styles of the\nspeaker notes shape."
}
},
- "id": "SlideProperties"
+ "id": "SlideProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type SLIDE.",
+ "type": "object"
},
"Response": {
"description": "A single response from an update.",
"type": "object",
"properties": {
- "createTable": {
- "description": "The result of creating a table.",
- "$ref": "CreateTableResponse"
- },
- "replaceAllText": {
- "description": "The result of replacing text.",
- "$ref": "ReplaceAllTextResponse"
- },
- "createSlide": {
- "$ref": "CreateSlideResponse",
- "description": "The result of creating a slide."
- },
- "duplicateObject": {
- "$ref": "DuplicateObjectResponse",
- "description": "The result of duplicating an object."
- },
- "createShape": {
- "description": "The result of creating a shape.",
- "$ref": "CreateShapeResponse"
- },
- "createLine": {
- "$ref": "CreateLineResponse",
- "description": "The result of creating a line."
- },
"createImage": {
- "description": "The result of creating an image.",
- "$ref": "CreateImageResponse"
+ "$ref": "CreateImageResponse",
+ "description": "The result of creating an image."
},
"createVideo": {
"$ref": "CreateVideoResponse",
@@ -3526,33 +2616,74 @@
"$ref": "ReplaceAllShapesWithSheetsChartResponse"
},
"replaceAllShapesWithImage": {
- "$ref": "ReplaceAllShapesWithImageResponse",
- "description": "The result of replacing all shapes matching some criteria with an\nimage."
+ "description": "The result of replacing all shapes matching some criteria with an\nimage.",
+ "$ref": "ReplaceAllShapesWithImageResponse"
+ },
+ "createTable": {
+ "$ref": "CreateTableResponse",
+ "description": "The result of creating a table."
+ },
+ "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."
+ },
+ "createShape": {
+ "$ref": "CreateShapeResponse",
+ "description": "The result of creating a shape."
+ },
+ "createLine": {
+ "description": "The result of creating a line.",
+ "$ref": "CreateLineResponse"
}
},
"id": "Response"
},
"TextRun": {
+ "id": "TextRun",
"description": "A TextElement kind that represents a run of text that all has the same\nstyling.",
"type": "object",
"properties": {
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The styling applied to this run."
+ },
"content": {
"description": "The text of this run.",
"type": "string"
- },
- "style": {
- "description": "The styling applied to this run.",
- "$ref": "TextStyle"
}
- },
- "id": "TextRun"
+ }
},
"LayoutReference": {
- "id": "LayoutReference",
"description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.",
"type": "object",
"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": [
@@ -3568,29 +2699,14 @@
"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"
]
- },
- "layoutId": {
- "description": "Layout ID: the object ID of one of the layouts in the presentation.",
- "type": "string"
}
- }
+ },
+ "id": "LayoutReference"
},
"SubstringMatchCriteria": {
+ "description": "A criteria that matches a specific string of text in a shape or table.",
+ "type": "object",
"properties": {
"text": {
"description": "The text to search for in the shape or table.",
@@ -3601,17 +2717,13 @@
"type": "boolean"
}
},
- "id": "SubstringMatchCriteria",
- "description": "A criteria that matches a specific string of text in a shape or table.",
- "type": "object"
+ "id": "SubstringMatchCriteria"
},
"TableRange": {
- "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
- "type": "object",
"properties": {
"location": {
- "$ref": "TableCellLocation",
- "description": "The starting location of the table range."
+ "description": "The starting location of the table range.",
+ "$ref": "TableCellLocation"
},
"rowSpan": {
"description": "The row span of the table range.",
@@ -3624,52 +2736,55 @@
"type": "integer"
}
},
- "id": "TableRange"
- },
- "CreateTableRequest": {
- "description": "Creates a new table.",
- "type": "object",
- "properties": {
- "objectId": {
- "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
- "type": "string"
- },
- "columns": {
- "description": "Number of columns in the table.",
- "format": "int32",
- "type": "integer"
- },
- "elementProperties": {
- "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": {
- "description": "Number of rows in the table.",
- "format": "int32",
- "type": "integer"
- }
- },
- "id": "CreateTableRequest"
+ "id": "TableRange",
+ "description": "A table range represents a reference to a subset of a table.\n\nIt's important to note that the cells specified by a table range do not\nnecessarily form a rectangle. For example, let's say we have a 3 x 3 table\nwhere all the cells of the last row are merged together. The table looks\nlike this:\n\n \n [ ]\n\nA table range with location = (0, 0), row span = 3 and column span = 2\nspecifies the following cells:\n\n x x \n [ x ]",
+ "type": "object"
},
"CreateTableResponse": {
"description": "The result of creating a table.",
"type": "object",
"properties": {
"objectId": {
- "description": "The object ID of the created table.",
- "type": "string"
+ "type": "string",
+ "description": "The object ID of the created table."
}
},
"id": "CreateTableResponse"
},
- "Table": {
- "description": "A PageElement kind representing a\ntable.",
+ "CreateTableRequest": {
+ "id": "CreateTableRequest",
+ "description": "Creates a new table.",
"type": "object",
"properties": {
+ "elementProperties": {
+ "$ref": "PageElementProperties",
+ "description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page."
+ },
+ "rows": {
+ "description": "Number of rows in the table.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "objectId": {
+ "type": "string",
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated."
+ },
"columns": {
"description": "Number of columns in the table.",
"format": "int32",
"type": "integer"
+ }
+ }
+ },
+ "Table": {
+ "id": "Table",
+ "description": "A PageElement kind representing a\ntable.",
+ "type": "object",
+ "properties": {
+ "columns": {
+ "type": "integer",
+ "description": "Number of columns in the table.",
+ "format": "int32"
},
"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.",
@@ -3684,25 +2799,23 @@
"type": "integer"
},
"tableColumns": {
- "description": "Properties of each column.",
"type": "array",
"items": {
"$ref": "TableColumnProperties"
- }
+ },
+ "description": "Properties of each column."
}
- },
- "id": "Table"
+ }
},
"PageBackgroundFill": {
"description": "The page background fill.",
"type": "object",
"properties": {
"solidFill": {
- "description": "Solid color fill.",
- "$ref": "SolidFill"
+ "$ref": "SolidFill",
+ "description": "Solid color fill."
},
"propertyState": {
- "type": "string",
"enumDescriptions": [
"If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.",
"If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.",
@@ -3713,7 +2826,8 @@
"NOT_RENDERED",
"INHERIT"
],
- "description": "The background fill property state.\n\nUpdating the 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."
+ "description": "The background fill property state.\n\nUpdating the the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.",
+ "type": "string"
},
"stretchedPictureFill": {
"$ref": "StretchedPictureFill",
@@ -3726,6 +2840,14 @@
"description": "A PageElement kind representing\na linked chart embedded from Google Sheets.",
"type": "object",
"properties": {
+ "sheetsChartProperties": {
+ "$ref": "SheetsChartProperties",
+ "description": "The properties of the Sheets chart."
+ },
+ "contentUrl": {
+ "type": "string",
+ "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change."
+ },
"spreadsheetId": {
"description": "The ID of the Google Sheets spreadsheet that contains the source chart.",
"type": "string"
@@ -3734,63 +2856,941 @@
"description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.",
"format": "int32",
"type": "integer"
- },
- "sheetsChartProperties": {
- "description": "The properties of the Sheets chart.",
- "$ref": "SheetsChartProperties"
- },
- "contentUrl": {
- "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.",
- "type": "string"
}
},
"id": "SheetsChart"
},
"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": {
- "color": {
- "description": "The color value of the solid fill.",
- "$ref": "OpaqueColor"
- },
"alpha": {
"description": "The fraction of this `color` that should be applied to the pixel.\nThat is, the final pixel color is defined by the equation:\n\n pixel color = alpha * (color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color.",
"format": "float",
"type": "number"
+ },
+ "color": {
+ "description": "The color value of the solid fill.",
+ "$ref": "OpaqueColor"
}
},
- "id": "SolidFill"
- }
- },
- "icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
- },
- "protocol": "rest",
- "canonicalName": "Slides",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/presentations": {
- "description": "View and manage your Google Slides presentations"
+ "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": {
+ "description": "The concrete color corresponding to the theme color type above.",
+ "$ref": "RgbColor"
},
- "https://www.googleapis.com/auth/presentations.readonly": {
- "description": "View your Google Slides presentations"
+ "type": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unspecified theme color. This value should not be used.",
+ "Represents the first dark color.",
+ "Represents the first light color.",
+ "Represents the second dark color.",
+ "Represents the second light color.",
+ "Represents the first accent color.",
+ "Represents the second accent color.",
+ "Represents the third accent color.",
+ "Represents the fourth accent color.",
+ "Represents the fifth accent color.",
+ "Represents the sixth accent color.",
+ "Represents the color to use for hyperlinks.",
+ "Represents the color to use for visited hyperlinks.",
+ "Represents the first text color.",
+ "Represents the first background color.",
+ "Represents the second text color.",
+ "Represents the second background color."
+ ],
+ "enum": [
+ "THEME_COLOR_TYPE_UNSPECIFIED",
+ "DARK1",
+ "LIGHT1",
+ "DARK2",
+ "LIGHT2",
+ "ACCENT1",
+ "ACCENT2",
+ "ACCENT3",
+ "ACCENT4",
+ "ACCENT5",
+ "ACCENT6",
+ "HYPERLINK",
+ "FOLLOWED_HYPERLINK",
+ "TEXT1",
+ "BACKGROUND1",
+ "TEXT2",
+ "BACKGROUND2"
+ ],
+ "description": "The type of the theme color."
+ }
+ },
+ "id": "ThemeColorPair",
+ "description": "A pair mapping a theme color type to the concrete color it represents."
+ },
+ "OptionalColor": {
+ "description": "A color that can either be fully opaque or fully transparent.",
+ "type": "object",
+ "properties": {
+ "opaqueColor": {
+ "$ref": "OpaqueColor",
+ "description": "If set, this will be used as an opaque color. If unset, this represents\na transparent color."
+ }
+ },
+ "id": "OptionalColor"
+ },
+ "PageElementProperties": {
+ "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.",
+ "type": "object",
+ "properties": {
+ "pageObjectId": {
+ "description": "The object ID of the page where the element is located.",
+ "type": "string"
},
- "https://www.googleapis.com/auth/spreadsheets.readonly": {
- "description": "View your Google Spreadsheets"
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the element."
},
- "https://www.googleapis.com/auth/drive": {
- "description": "View and manage the files in your Google Drive"
+ "transform": {
+ "$ref": "AffineTransform",
+ "description": "The transform for the element."
+ }
+ },
+ "id": "PageElementProperties"
+ },
+ "SheetsChartProperties": {
+ "id": "SheetsChartProperties",
+ "description": "The properties of the SheetsChart.",
+ "type": "object",
+ "properties": {
+ "chartImageProperties": {
+ "$ref": "ImageProperties",
+ "description": "The properties of the embedded chart image."
+ }
+ }
+ },
+ "StretchedPictureFill": {
+ "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.",
+ "type": "string"
},
- "https://www.googleapis.com/auth/drive.readonly": {
- "description": "View the files in your Google Drive"
+ "size": {
+ "description": "The original size of the picture fill. This field is read-only.",
+ "$ref": "Size"
+ }
+ },
+ "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": {
+ "id": "UpdateTextStyleRequest",
+ "description": "Update the styling of text in a Shape or\nTable.",
+ "type": "object",
+ "properties": {
+ "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."
},
- "https://www.googleapis.com/auth/spreadsheets": {
- "description": "View and manage your spreadsheets in Google Drive"
+ "style": {
+ "$ref": "TextStyle",
+ "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information."
+ },
+ "fields": {
+ "type": "string",
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask"
+ },
+ "objectId": {
+ "description": "The object ID of the shape or table with the text to be styled.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style."
+ }
+ }
+ },
+ "DeleteTableColumnRequest": {
+ "properties": {
+ "cellLocation": {
+ "$ref": "TableCellLocation",
+ "description": "The reference table cell location from which a column will be deleted.\n\nThe column this cell spans will be deleted. If this is a merged cell,\nmultiple columns will be deleted. If no columns remain in the table after\nthis deletion, the whole table is deleted."
+ },
+ "tableObjectId": {
+ "description": "The table to delete columns from.",
+ "type": "string"
+ }
+ },
+ "id": "DeleteTableColumnRequest",
+ "description": "Deletes a column from a table.",
+ "type": "object"
+ },
+ "List": {
+ "properties": {
+ "nestingLevel": {
+ "additionalProperties": {
+ "$ref": "NestingLevel"
+ },
+ "description": "A map of nesting levels to the properties of bullets at the associated\nlevel. A list has at most nine levels of nesting, so the possible values\nfor the keys of this map are 0 through 8, inclusive.",
+ "type": "object"
+ },
+ "listId": {
+ "description": "The ID of the list.",
+ "type": "string"
+ }
+ },
+ "id": "List",
+ "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.",
+ "type": "object"
+ },
+ "PageElement": {
+ "properties": {
+ "line": {
+ "$ref": "Line",
+ "description": "A line page element."
+ },
+ "description": {
+ "description": "The description of the page element. Combined with title to display alt\ntext.",
+ "type": "string"
+ },
+ "elementGroup": {
+ "$ref": "Group",
+ "description": "A collection of page elements joined as a single unit."
+ },
+ "image": {
+ "$ref": "Image",
+ "description": "An image page element."
+ },
+ "size": {
+ "$ref": "Size",
+ "description": "The size of the page element."
+ },
+ "title": {
+ "description": "The title of the page element. Combined with description to display alt\ntext.",
+ "type": "string"
+ },
+ "sheetsChart": {
+ "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.",
+ "$ref": "SheetsChart"
+ },
+ "video": {
+ "$ref": "Video",
+ "description": "A video page element."
+ },
+ "wordArt": {
+ "$ref": "WordArt",
+ "description": "A word art page element."
+ },
+ "table": {
+ "description": "A table page element.",
+ "$ref": "Table"
+ },
+ "transform": {
+ "description": "The transform of the page element.",
+ "$ref": "AffineTransform"
+ },
+ "objectId": {
+ "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.",
+ "type": "string"
+ },
+ "shape": {
+ "$ref": "Shape",
+ "description": "A generic shape."
+ }
+ },
+ "id": "PageElement",
+ "description": "A visual element rendered on a page.",
+ "type": "object"
+ },
+ "CreateImageRequest": {
+ "description": "Creates an image.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.",
+ "type": "string"
+ },
+ "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."
+ }
+ },
+ "id": "CreateImageRequest"
+ },
+ "CreateParagraphBulletsRequest": {
+ "id": "CreateParagraphBulletsRequest",
+ "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to add bullets to.",
+ "type": "string"
+ },
+ "textRange": {
+ "description": "The range of text to apply the bullet presets to, based on TextElement indexes.",
+ "$ref": "Range"
+ },
+ "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 `DISC` 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": {
+ "$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."
+ }
+ }
+ },
+ "Size": {
+ "description": "A width and height.",
+ "type": "object",
+ "properties": {
+ "width": {
+ "description": "The width of the object.",
+ "$ref": "Dimension"
+ },
+ "height": {
+ "$ref": "Dimension",
+ "description": "The height of the object."
+ }
+ },
+ "id": "Size"
+ },
+ "TextStyle": {
+ "id": "TextStyle",
+ "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.",
+ "type": "object",
+ "properties": {
+ "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.",
+ "$ref": "Link"
+ },
+ "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"
+ },
+ "strikethrough": {
+ "description": "Whether or not the text is struck through.",
+ "type": "boolean"
+ },
+ "italic": {
+ "description": "Whether or not the text is italicized.",
+ "type": "boolean"
+ },
+ "fontSize": {
+ "$ref": "Dimension",
+ "description": "The size of the text's font. When read, the `font_size` will specified in\npoints."
+ },
+ "smallCaps": {
+ "description": "Whether or not the text is in small capital letters.",
+ "type": "boolean"
+ },
+ "baselineOffset": {
+ "enumDescriptions": [
+ "The text's baseline offset is inherited from the parent.",
+ "The text is not vertically offset.",
+ "The text is vertically offset upwards (superscript).",
+ "The text is vertically offset downwards (subscript)."
+ ],
+ "enum": [
+ "BASELINE_OFFSET_UNSPECIFIED",
+ "NONE",
+ "SUPERSCRIPT",
+ "SUBSCRIPT"
+ ],
+ "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.",
+ "type": "string"
+ },
+ "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."
+ }
+ }
+ },
+ "UpdateVideoPropertiesRequest": {
+ "description": "Update the properties of a Video.",
+ "type": "object",
+ "properties": {
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "objectId": {
+ "description": "The object ID of the video the updates are applied to.",
+ "type": "string"
+ },
+ "videoProperties": {
+ "$ref": "VideoProperties",
+ "description": "The video properties to update."
+ }
+ },
+ "id": "UpdateVideoPropertiesRequest"
+ },
+ "Request": {
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "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."
+ },
+ "replaceAllShapesWithImage": {
+ "description": "Replaces all shapes matching some criteria with an image.",
+ "$ref": "ReplaceAllShapesWithImageRequest"
+ },
+ "replaceAllText": {
+ "$ref": "ReplaceAllTextRequest",
+ "description": "Replaces all instances of specified text."
+ },
+ "updateImageProperties": {
+ "description": "Updates the properties of an Image.",
+ "$ref": "UpdateImagePropertiesRequest"
+ },
+ "createSlide": {
+ "description": "Creates a new slide.",
+ "$ref": "CreateSlideRequest"
+ },
+ "insertTableRows": {
+ "$ref": "InsertTableRowsRequest",
+ "description": "Inserts rows into a table."
+ },
+ "updateLineProperties": {
+ "$ref": "UpdateLinePropertiesRequest",
+ "description": "Updates the properties of a Line."
+ },
+ "updateSlidesPosition": {
+ "$ref": "UpdateSlidesPositionRequest",
+ "description": "Updates the position of a set of slides in the presentation."
+ },
+ "deleteTableRow": {
+ "$ref": "DeleteTableRowRequest",
+ "description": "Deletes a row from a table."
+ },
+ "updateShapeProperties": {
+ "$ref": "UpdateShapePropertiesRequest",
+ "description": "Updates the properties of a Shape."
+ },
+ "insertText": {
+ "description": "Inserts text into a shape or table cell.",
+ "$ref": "InsertTextRequest"
+ },
+ "deleteText": {
+ "description": "Deletes text from a shape or a table cell.",
+ "$ref": "DeleteTextRequest"
+ },
+ "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."
+ },
+ "insertTableColumns": {
+ "$ref": "InsertTableColumnsRequest",
+ "description": "Inserts columns into a table."
+ },
+ "refreshSheetsChart": {
+ "$ref": "RefreshSheetsChartRequest",
+ "description": "Refreshes a Google Sheets chart."
+ },
+ "createTable": {
+ "$ref": "CreateTableRequest",
+ "description": "Creates a new table."
+ },
+ "updateTableCellProperties": {
+ "description": "Updates the properties of a TableCell.",
+ "$ref": "UpdateTableCellPropertiesRequest"
+ },
+ "deleteObject": {
+ "$ref": "DeleteObjectRequest",
+ "description": "Deletes a page or page element from the presentation."
+ },
+ "updateParagraphStyle": {
+ "$ref": "UpdateParagraphStyleRequest",
+ "description": "Updates the styling of paragraphs within a Shape or Table."
+ },
+ "deleteTableColumn": {
+ "description": "Deletes a column from a table.",
+ "$ref": "DeleteTableColumnRequest"
+ },
+ "duplicateObject": {
+ "description": "Duplicates a slide or page element.",
+ "$ref": "DuplicateObjectRequest"
+ },
+ "updateVideoProperties": {
+ "$ref": "UpdateVideoPropertiesRequest",
+ "description": "Updates the properties of a Video."
+ },
+ "createLine": {
+ "description": "Creates a line.",
+ "$ref": "CreateLineRequest"
+ }
+ },
+ "id": "Request",
+ "description": "A single kind of update to apply to a presentation."
+ },
+ "UpdateImagePropertiesRequest": {
+ "description": "Update the properties of an Image.",
+ "type": "object",
+ "properties": {
+ "imageProperties": {
+ "description": "The image properties to update.",
+ "$ref": "ImageProperties"
+ },
+ "objectId": {
+ "description": "The object ID of the image the updates are applied to.",
+ "type": "string"
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ },
+ "id": "UpdateImagePropertiesRequest"
+ },
+ "ParagraphStyle": {
+ "description": "Styles that apply to a whole paragraph.\n\nIf this text is contained in a shape with a parent placeholder, then these paragraph styles may be\ninherited from the parent. Which paragraph styles are inherited depend on the\nnesting level of lists:\n\n* A paragraph not in a list will inherit its paragraph style from the\n paragraph at the 0 nesting level of the list inside the parent placeholder.\n* A paragraph in a list will inherit its paragraph style from the paragraph\n at its corresponding nesting level of the list inside the parent\n placeholder.\n\nInherited paragraph styles are represented as unset fields in this message.",
+ "type": "object",
+ "properties": {
+ "spaceBelow": {
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "direction": {
+ "enumDescriptions": [
+ "The text direction is inherited from the parent.",
+ "The text goes from left to right.",
+ "The text goes from right to left."
+ ],
+ "enum": [
+ "TEXT_DIRECTION_UNSPECIFIED",
+ "LEFT_TO_RIGHT",
+ "RIGHT_TO_LEFT"
+ ],
+ "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT\nsince text direction is not inherited.",
+ "type": "string"
+ },
+ "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": {
+ "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "spaceAbove": {
+ "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.",
+ "$ref": "Dimension"
+ },
+ "alignment": {
+ "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."
+ ],
+ "enum": [
+ "ALIGNMENT_UNSPECIFIED",
+ "START",
+ "CENTER",
+ "END",
+ "JUSTIFIED"
+ ]
+ },
+ "lineSpacing": {
+ "type": "number",
+ "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.",
+ "format": "float"
+ },
+ "indentFirstLine": {
+ "$ref": "Dimension",
+ "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent."
+ }
+ },
+ "id": "ParagraphStyle"
+ },
+ "ReplaceAllShapesWithSheetsChartResponse": {
+ "type": "object",
+ "properties": {
+ "occurrencesChanged": {
+ "description": "The number of shapes replaced with charts.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "ReplaceAllShapesWithSheetsChartResponse",
+ "description": "The result of replacing shapes with a Google Sheets chart."
+ },
+ "TableCellProperties": {
+ "description": "The properties of the TableCell.",
+ "type": "object",
+ "properties": {
+ "tableCellBackgroundFill": {
+ "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"
+ },
+ "Outline": {
+ "id": "Outline",
+ "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.",
+ "type": "object",
+ "properties": {
+ "outlineFill": {
+ "description": "The fill of the outline.",
+ "$ref": "OutlineFill"
+ },
+ "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": {
+ "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."
+ ],
+ "enum": [
+ "RENDERED",
+ "NOT_RENDERED",
+ "INHERIT"
+ ]
+ }
+ }
+ },
+ "RefreshSheetsChartRequest": {
+ "id": "RefreshSheetsChartRequest",
+ "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the chart to refresh.",
+ "type": "string"
+ }
+ }
+ },
+ "TableColumnProperties": {
+ "description": "Properties of each column in a table.",
+ "type": "object",
+ "properties": {
+ "columnWidth": {
+ "$ref": "Dimension",
+ "description": "Width of a column."
+ }
+ },
+ "id": "TableColumnProperties"
+ },
+ "ShapeProperties": {
+ "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.",
+ "type": "object",
+ "properties": {
+ "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."
+ },
+ "shapeBackgroundFill": {
+ "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor.",
+ "$ref": "ShapeBackgroundFill"
+ },
+ "shadow": {
+ "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only.",
+ "$ref": "Shadow"
+ }
+ },
+ "id": "ShapeProperties"
+ },
+ "NotesProperties": {
+ "properties": {
+ "speakerNotesObjectId": {
+ "description": "The object ID of the shape on this notes page that contains the speaker\nnotes for the corresponding slide.\nThe actual shape may not always exist on the notes page. Inserting text\nusing this object ID will automatically create the shape. In this case, the\nactual shape may have different object ID. The `GetPresentation` or\n`GetPage` action will always return the latest object ID.",
+ "type": "string"
+ }
+ },
+ "id": "NotesProperties",
+ "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.",
+ "type": "object"
+ },
+ "TableRow": {
+ "properties": {
+ "rowHeight": {
+ "description": "Height of a row.",
+ "$ref": "Dimension"
+ },
+ "tableCells": {
+ "description": "Properties and contents of each cell.\n\nCells that span multiple columns are represented only once with a\ncolumn_span greater\nthan 1. As a result, the length of this collection does not always match\nthe number of columns of the entire table.",
+ "type": "array",
+ "items": {
+ "$ref": "TableCell"
+ }
+ }
+ },
+ "id": "TableRow",
+ "description": "Properties and contents of each row in a table.",
+ "type": "object"
+ },
+ "UpdateTableCellPropertiesRequest": {
+ "id": "UpdateTableCellPropertiesRequest",
+ "description": "Update the properties of a TableCell.",
+ "type": "object",
+ "properties": {
+ "objectId": {
+ "description": "The object ID of the table.",
+ "type": "string"
+ },
+ "tableRange": {
+ "$ref": "TableRange",
+ "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table."
+ },
+ "tableCellProperties": {
+ "description": "The table cell properties to update.",
+ "$ref": "TableCellProperties"
+ },
+ "fields": {
+ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.",
+ "format": "google-fieldmask",
+ "type": "string"
+ }
+ }
+ },
+ "CreateSlideRequest": {
+ "description": "Creates a new slide.",
+ "type": "object",
+ "properties": {
+ "insertionIndex": {
+ "description": "The optional zero-based index indicating where to insert the slides.\n\nIf you don't specify an index, the new slide is created at the end.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "placeholderIdMappings": {
+ "description": "An optional list of object ID mappings from the placeholder(s) on the layout to the placeholder(s)\nthat will be created on the new slide from that specified layout. Can only\nbe used when `slide_layout_reference` is specified.",
+ "type": "array",
+ "items": {
+ "$ref": "LayoutPlaceholderIdMapping"
+ }
+ },
+ "slideLayoutReference": {
+ "$ref": "LayoutReference",
+ "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`."
+ },
+ "objectId": {
+ "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.",
+ "type": "string"
+ }
+ },
+ "id": "CreateSlideRequest"
+ },
+ "BatchUpdatePresentationRequest": {
+ "type": "object",
+ "properties": {
+ "writeControl": {
+ "$ref": "WriteControl",
+ "description": "Provides control over how write requests are executed, such as\nconditionally updating the presentation."
+ },
+ "requests": {
+ "description": "A list of updates to apply to the presentation.",
+ "type": "array",
+ "items": {
+ "$ref": "Request"
+ }
+ }
+ },
+ "id": "BatchUpdatePresentationRequest",
+ "description": "Request message for PresentationsService.BatchUpdatePresentation."
+ },
+ "TextContent": {
+ "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.",
+ "type": "object",
+ "properties": {
+ "textElements": {
+ "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only.",
+ "type": "array",
+ "items": {
+ "$ref": "TextElement"
+ }
+ },
+ "lists": {
+ "description": "The bulleted lists contained in this text, keyed by list ID.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "List"
+ }
+ }
+ },
+ "id": "TextContent"
+ },
+ "CreateSheetsChartResponse": {
+ "id": "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"
+ }
+ }
+ },
+ "WriteControl": {
+ "properties": {
+ "requiredRevisionId": {
+ "description": "The revision ID of the presentation required for the write request. If\nspecified and the `required_revision_id` doesn't exactly match the\npresentation's current `revision_id`, the request will not be processed and\nwill return a 400 bad request error.",
+ "type": "string"
+ }
+ },
+ "id": "WriteControl",
+ "description": "Provides control over how write requests are executed.",
+ "type": "object"
+ },
+ "DeleteParagraphBulletsRequest": {
+ "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": {
+ "objectId": {
+ "description": "The object ID of the shape or table containing the text to delete bullets\nfrom.",
+ "type": "string"
+ },
+ "textRange": {
+ "$ref": "Range",
+ "description": "The range of text to delete bullets from, based on TextElement indexes."
+ },
+ "cellLocation": {
+ "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"
}
}
}
+ },
+ "protocol": "rest",
+ "icons": {
+ "x32": "http://www.google.com/images/icons/product/search-32.gif",
+ "x16": "http://www.google.com/images/icons/product/search-16.gif"
}
}
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json
index 78cef78..b61c5f1 100644
--- a/sourcerepo/v1/sourcerepo-api.json
+++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,660 +1,11 @@
{
- "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.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Repo"
- },
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "id": "sourcerepo.projects.repos.get",
- "path": "v1/{+name}"
- },
- "testIamPermissions": {
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "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"
- }
- },
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
- "id": "sourcerepo.projects.repos.delete",
- "path": "v1/{+name}",
- "description": "Deletes a repo."
- },
- "list": {
- "path": "v1/{+name}/repos",
- "id": "sourcerepo.projects.repos.list",
- "description": "Returns all repos belonging to a project.",
- "response": {
- "$ref": "ListReposResponse"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path",
- "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`."
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/repos"
- },
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path",
- "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "sourcerepo.projects.repos.setIamPolicy"
- },
- "create": {
- "id": "sourcerepo.projects.repos.create",
- "path": "v1/{+parent}/repos",
- "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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Repo"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "The project in which to create the repo. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos"
- },
- "getIamPolicy": {
- "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": {
- "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/repos/.+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "sourcerepo.projects.repos.getIamPolicy"
- }
- }
- }
- }
- }
- },
- "parameters": {
- "callback": {
- "location": "query",
- "description": "JSONP",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ]
- },
- "alt": {
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string"
- },
- "access_token": {
- "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": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string"
- }
- },
- "version": "v1",
- "baseUrl": "https://sourcerepo.googleapis.com/",
- "kind": "discovery#restDescription",
- "servicePath": "",
- "description": "Access source code repositories hosted by Google.",
- "basePath": "",
"id": "sourcerepo:v1",
- "revision": "20170228",
"documentationLink": "https://cloud.google.com/eap/cloud-repositories/cloud-sourcerepo-api",
+ "revision": "20170228",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "DataAccessOptions": {
- "type": "object",
- "properties": {},
- "id": "DataAccessOptions",
- "description": "Write a Data Access (Gin) log"
- },
- "AuditConfig": {
- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
- "type": "object",
- "properties": {
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- }
- },
- "id": "AuditConfig"
- },
- "SetIamPolicyRequest": {
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object",
- "properties": {
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- },
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- }
- },
- "id": "SetIamPolicyRequest"
- },
- "CloudAuditOptions": {
- "properties": {},
- "id": "CloudAuditOptions",
- "description": "Write a Cloud Audit log",
- "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* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "role": {
- "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired",
- "type": "string"
- }
- },
- "id": "Binding"
- },
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {},
- "id": "Empty"
- },
- "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": {
- "id": "Repo",
- "description": "A repository (or repo) is a Git repository storing versioned source content.",
- "type": "object",
- "properties": {
- "mirrorConfig": {
- "description": "How this repository mirrors a repository managed by another service.",
- "$ref": "MirrorConfig"
- },
- "url": {
- "description": "URL to clone the repository from Google Cloud Source Repositories.",
- "type": "string"
- },
- "size": {
- "description": "The size in bytes of the repo.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "type": "string",
- "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`."
- }
- }
- },
- "TestIamPermissionsResponse": {
- "type": "object",
- "properties": {
- "permissions": {
- "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "TestIamPermissionsResponse",
- "description": "Response message for `TestIamPermissions` method."
- },
- "ListReposResponse": {
- "description": "Response for ListRepos.",
- "type": "object",
- "properties": {
- "repos": {
- "description": "The listed repos.",
- "type": "array",
- "items": {
- "$ref": "Repo"
- }
- }
- },
- "id": "ListReposResponse"
- },
- "Condition": {
- "description": "A condition to be met.",
- "type": "object",
- "properties": {
- "op": {
- "type": "string",
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
- "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
- "Subject is discharged"
- ],
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "description": "An operator to apply the subject with."
- },
- "svc": {
- "description": "Trusted attributes discharged by the service.",
- "type": "string"
- },
- "value": {
- "description": "DEPRECATED. Use 'values' instead.",
- "type": "string"
- },
- "sys": {
- "enumDescriptions": [
- "Default non-attribute type",
- "Region of the resource",
- "Service name",
- "Resource name",
- "IP address of the caller"
- ],
- "enum": [
- "NO_ATTR",
- "REGION",
- "SERVICE",
- "NAME",
- "IP"
- ],
- "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
- "type": "string"
- },
- "iam": {
- "type": "string",
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
- "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
- ],
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "APPROVER",
- "JUSTIFICATION_TYPE"
- ],
- "description": "Trusted attributes supplied by the IAM system."
- },
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "Condition"
- },
- "CounterOptions": {
- "description": "Options for counters",
- "type": "object",
- "properties": {
- "metric": {
- "description": "The metric to update.",
- "type": "string"
- },
- "field": {
- "description": "The field value to attribute.",
- "type": "string"
- }
- },
- "id": "CounterOptions"
- },
- "AuditLogConfig": {
- "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
- "type": "object",
- "properties": {
- "exemptedMembers": {
- "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "logType": {
- "enumDescriptions": [
- "Default case. Should never be this.",
- "Admin reads. Example: CloudIAM getIamPolicy",
- "Data writes. Example: CloudSQL Users create",
- "Data reads. Example: CloudSQL Users list"
- ],
- "enum": [
- "LOG_TYPE_UNSPECIFIED",
- "ADMIN_READ",
- "DATA_WRITE",
- "DATA_READ"
- ],
- "description": "The log type that this config enables.",
- "type": "string"
- }
- },
- "id": "AuditLogConfig"
- },
- "Rule": {
- "description": "A rule to be applied in a Policy.",
- "type": "object",
- "properties": {
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Human-readable description of the rule.",
- "type": "string"
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "type": "array",
- "items": {
- "$ref": "Condition"
- }
- },
- "logConfig": {
- "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
- "type": "array",
- "items": {
- "$ref": "LogConfig"
- }
- },
- "in": {
- "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "permissions": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs."
- },
- "action": {
- "enum": [
- "NO_ACTION",
- "ALLOW",
- "ALLOW_WITH_LOG",
- "DENY",
- "DENY_WITH_LOG",
- "LOG"
- ],
- "description": "Required",
- "type": "string",
- "enumDescriptions": [
- "Default no action.",
- "Matching 'Entries' grant access.",
- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' deny access.",
- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' tell IAM.Check callers to generate logs."
- ]
- }
- },
- "id": "Rule"
- },
- "LogConfig": {
- "id": "LogConfig",
- "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
- "type": "object",
- "properties": {
- "counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
- },
- "dataAccess": {
- "description": "Data access options.",
- "$ref": "DataAccessOptions"
- },
- "cloudAudit": {
- "description": "Cloud audit options.",
- "$ref": "CloudAuditOptions"
- }
- }
- },
"TestIamPermissionsRequest": {
- "description": "Request message for `TestIamPermissions` method.",
"type": "object",
"properties": {
"permissions": {
@@ -665,15 +16,14 @@
}
}
},
- "id": "TestIamPermissionsRequest"
+ "id": "TestIamPermissionsRequest",
+ "description": "Request message for `TestIamPermissions` method."
},
"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": {
- "iamOwned": {
- "type": "boolean"
- },
"rules": {
"description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
"type": "array",
@@ -704,16 +54,373 @@
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
"format": "byte",
"type": "string"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ }
+ }
+ },
+ "DataAccessOptions": {
+ "description": "Write a Data Access (Gin) log",
+ "type": "object",
+ "properties": {},
+ "id": "DataAccessOptions"
+ },
+ "AuditConfig": {
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg 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.\nExample Policy with multiple AuditConfigs:\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}\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.",
+ "type": "object",
+ "properties": {
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ },
+ "exemptedMembers": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
}
},
- "id": "Policy"
+ "id": "AuditConfig"
+ },
+ "SetIamPolicyRequest": {
+ "type": "object",
+ "properties": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest",
+ "description": "Request message for `SetIamPolicy` method."
+ },
+ "CloudAuditOptions": {
+ "type": "object",
+ "properties": {},
+ "id": "CloudAuditOptions",
+ "description": "Write a Cloud Audit log"
+ },
+ "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* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "role": {
+ "type": "string",
+ "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired"
+ }
+ },
+ "id": "Binding"
+ },
+ "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 `{}`."
+ },
+ "MirrorConfig": {
+ "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.",
+ "type": "object",
+ "properties": {
+ "deployKeyId": {
+ "type": "string",
+ "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."
+ },
+ "url": {
+ "type": "string",
+ "description": "URL of the main repository at the other hosting service."
+ },
+ "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": {
+ "type": "object",
+ "properties": {
+ "mirrorConfig": {
+ "description": "How this repository mirrors a repository managed by another service.",
+ "$ref": "MirrorConfig"
+ },
+ "url": {
+ "description": "URL to clone the repository from Google Cloud Source Repositories.",
+ "type": "string"
+ },
+ "size": {
+ "description": "The size in bytes of the repo.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "type": "string"
+ }
+ },
+ "id": "Repo",
+ "description": "A repository (or repo) is a Git repository storing versioned source content."
+ },
+ "Condition": {
+ "description": "A condition to be met.",
+ "type": "object",
+ "properties": {
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "iam": {
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "An approver (distinct from the requester) that has authorized this\nrequest.\nWhen used with IN, the condition indicates that one of the approvers\nassociated with the request matches the specified principal, or is a\nmember of the specified group. Approvers can only grant additional\naccess, and are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT_IN).\nSee: go/rpc-security-policy-dynamicauth.",
+ "What types of justifications have been supplied with this request.\nString values should match enum names from tech.iam.JustificationType,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *absence* of a justification, so justification conditions can only\nbe used in a \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported."
+ ],
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "APPROVER",
+ "JUSTIFICATION_TYPE"
+ ],
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string"
+ },
+ "op": {
+ "description": "An operator to apply the subject with.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "The condition is true if the subject (or any element of it if it is\na set) matches any of the supplied values.",
+ "The condition is true if the subject (or every element of it if it is\na set) matches none of the supplied values.",
+ "Subject is discharged"
+ ],
+ "enum": [
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
+ ]
+ },
+ "svc": {
+ "type": "string",
+ "description": "Trusted attributes discharged by the service."
+ },
+ "sys": {
+ "description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default non-attribute type",
+ "Region of the resource",
+ "Service name",
+ "Resource name",
+ "IP address of the caller"
+ ],
+ "enum": [
+ "NO_ATTR",
+ "REGION",
+ "SERVICE",
+ "NAME",
+ "IP"
+ ]
+ },
+ "value": {
+ "description": "DEPRECATED. Use 'values' instead.",
+ "type": "string"
+ }
+ },
+ "id": "Condition"
+ },
+ "ListReposResponse": {
+ "description": "Response for ListRepos.",
+ "type": "object",
+ "properties": {
+ "repos": {
+ "description": "The listed repos.",
+ "type": "array",
+ "items": {
+ "$ref": "Repo"
+ }
+ }
+ },
+ "id": "ListReposResponse"
+ },
+ "TestIamPermissionsResponse": {
+ "description": "Response message for `TestIamPermissions` method.",
+ "type": "object",
+ "properties": {
+ "permissions": {
+ "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "TestIamPermissionsResponse"
+ },
+ "CounterOptions": {
+ "type": "object",
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
+ "id": "CounterOptions",
+ "description": "Options for counters"
+ },
+ "AuditLogConfig": {
+ "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.",
+ "type": "object",
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "logType": {
+ "description": "The log type that this config enables.",
+ "type": "string",
+ "enumDescriptions": [
+ "Default case. Should never be this.",
+ "Admin reads. Example: CloudIAM getIamPolicy",
+ "Data writes. Example: CloudSQL Users create",
+ "Data reads. Example: CloudSQL Users list"
+ ],
+ "enum": [
+ "LOG_TYPE_UNSPECIFIED",
+ "ADMIN_READ",
+ "DATA_WRITE",
+ "DATA_READ"
+ ]
+ }
+ },
+ "id": "AuditLogConfig"
+ },
+ "Rule": {
+ "description": "A rule to be applied in a Policy.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
+ }
+ },
+ "logConfig": {
+ "type": "array",
+ "items": {
+ "$ref": "LogConfig"
+ },
+ "description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action."
+ },
+ "in": {
+ "description": "If one or more 'in' clauses are specified, the rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "permissions": {
+ "description": "A permission is a string of form '\u003cservice\u003e.\u003cresource type\u003e.\u003cverb\u003e'\n(e.g., 'storage.buckets.list'). A value of '*' matches all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "action": {
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ],
+ "enum": [
+ "NO_ACTION",
+ "ALLOW",
+ "ALLOW_WITH_LOG",
+ "DENY",
+ "DENY_WITH_LOG",
+ "LOG"
+ ],
+ "description": "Required",
+ "type": "string"
+ },
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "id": "Rule"
+ },
+ "LogConfig": {
+ "description": "Specifies what kind of log the caller must write\nIncrement a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only,\nand end in \"_count\". Field names should not contain an initial slash.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are\ntheir respective values.\n\nAt present the only supported field names are\n - \"iam_principal\", corresponding to IAMContext.principal;\n - \"\" (empty string), resulting in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \"iam_principal\" }\n ==\u003e increment counter /iam/policy/backend_debug_access_count\n {iam_principal=[value of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field names (though this may be supported in the future)\n* decrementing the counter\n* incrementing it by anything other than 1",
+ "type": "object",
+ "properties": {
+ "dataAccess": {
+ "description": "Data access options.",
+ "$ref": "DataAccessOptions"
+ },
+ "cloudAudit": {
+ "$ref": "CloudAuditOptions",
+ "description": "Cloud audit options."
+ },
+ "counter": {
+ "description": "Counter options.",
+ "$ref": "CounterOptions"
+ }
+ },
+ "id": "LogConfig"
}
},
- "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 Source Repositories",
"auth": {
"oauth2": {
@@ -724,5 +431,298 @@
}
}
},
- "rootUrl": "https://sourcerepo.googleapis.com/"
+ "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": {
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.",
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "sourcerepo.projects.repos.testIamPermissions"
+ },
+ "delete": {
+ "description": "Deletes a repo.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.delete"
+ },
+ "list": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListReposResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "The project ID whose repos should be listed. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+name}/repos",
+ "id": "sourcerepo.projects.repos.list",
+ "description": "Returns all repos belonging to a project."
+ },
+ "setIamPolicy": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ }
+ },
+ "create": {
+ "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`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos",
+ "path": "v1/{+parent}/repos",
+ "id": "sourcerepo.projects.repos.create",
+ "request": {
+ "$ref": "Repo"
+ },
+ "description": "Creates a repo in the given project with the given name..\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`."
+ },
+ "getIamPolicy": {
+ "id": "sourcerepo.projects.repos.getIamPolicy",
+ "path": "v1/{+resource}:getIamPolicy",
+ "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "parameters": {
+ "resource": {
+ "location": "path",
+ "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/repos/.+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy"
+ },
+ "get": {
+ "response": {
+ "$ref": "Repo"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/repos/.+$",
+ "location": "path",
+ "description": "The name of the requested repository. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/repos/{reposId}",
+ "path": "v1/{+name}",
+ "id": "sourcerepo.projects.repos.get",
+ "description": "Returns information about a repo."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "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": {
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "type": "string",
+ "location": "query"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string",
+ "location": "query"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://sourcerepo.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Access source code repositories hosted by Google.",
+ "servicePath": "",
+ "basePath": ""
}
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json
index fc23fe3..e80066b 100644
--- a/spanner/v1/spanner-api.json
+++ b/spanner/v1/spanner-api.json
@@ -1,476 +1,1184 @@
{
+ "resources": {
+ "projects": {
+ "resources": {
+ "instances": {
+ "resources": {
+ "databases": {
+ "methods": {
+ "getIamPolicy": {
+ "path": "v1/{+resource}:getIamPolicy",
+ "id": "spanner.projects.instances.databases.getIamPolicy",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ },
+ "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.",
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy"
+ },
+ "get": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Database"
+ },
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database to be dropped.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
+ "path": "v1/{+database}",
+ "id": "spanner.projects.instances.databases.dropDatabase"
+ },
+ "updateDdl": {
+ "path": "v1/{+database}/ddl",
+ "id": "spanner.projects.instances.databases.updateDdl",
+ "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.",
+ "request": {
+ "$ref": "UpdateDatabaseDdlRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ },
+ "testIamPermissions": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "resource"
+ ],
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
+ "id": "spanner.projects.instances.databases.testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions."
+ },
+ "getDdl": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "GetDatabaseDdlResponse"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "parameters": {
+ "database": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path",
+ "description": "Required. The database whose schema we wish to get.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl",
+ "id": "spanner.projects.instances.databases.getDdl",
+ "path": "v1/{+database}/ddl",
+ "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListDatabasesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "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"
+ },
+ "pageToken": {
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
+ "type": "string",
+ "location": "query"
+ },
+ "pageSize": {
+ "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
+ "path": "v1/{+parent}/databases",
+ "id": "spanner.projects.instances.databases.list",
+ "description": "Lists Cloud Spanner databases."
+ },
+ "create": {
+ "id": "spanner.projects.instances.databases.create",
+ "path": "v1/{+parent}/databases",
+ "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
+ "request": {
+ "$ref": "CreateDatabaseRequest"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "parent"
+ ],
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
+ },
+ "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/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.databases.setIamPolicy",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ },
+ "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource."
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "cancel": {
+ "httpMethod": "POST",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel",
+ "id": "spanner.projects.instances.databases.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": {
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.",
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "id": "spanner.projects.instances.databases.operations.delete",
+ "path": "v1/{+name}"
+ },
+ "list": {
+ "id": "spanner.projects.instances.databases.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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the operation collection.",
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}",
+ "id": "spanner.projects.instances.databases.operations.get",
+ "path": "v1/{+name}",
+ "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
+ }
+ }
+ },
+ "sessions": {
+ "methods": {
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read",
+ "path": "v1/{+session}:read",
+ "id": "spanner.projects.instances.databases.sessions.read"
+ },
+ "get": {
+ "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",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the session to retrieve.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}"
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the session to delete.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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."
+ },
+ "beginTransaction": {
+ "id": "spanner.projects.instances.databases.sessions.beginTransaction",
+ "path": "v1/{+session}:beginTransaction",
+ "request": {
+ "$ref": "BeginTransactionRequest"
+ },
+ "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "Transaction"
+ },
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the transaction runs.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction"
+ },
+ "commit": {
+ "response": {
+ "$ref": "CommitResponse"
+ },
+ "parameterOrder": [
+ "session"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit",
+ "path": "v1/{+session}:commit",
+ "id": "spanner.projects.instances.databases.sessions.commit",
+ "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
+ "request": {
+ "$ref": "CommitRequest"
+ }
+ },
+ "executeStreamingSql": {
+ "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
+ "path": "v1/{+session}: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"
+ },
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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"
+ },
+ "executeSql": {
+ "id": "spanner.projects.instances.databases.sessions.executeSql",
+ "path": "v1/{+session}:executeSql",
+ "request": {
+ "$ref": "ExecuteSqlRequest"
+ },
+ "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "ResultSet"
+ },
+ "parameters": {
+ "session": {
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
+ },
+ "rollback": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameters": {
+ "session": {
+ "description": "Required. The session in which the transaction to roll back is running.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
+ "id": "spanner.projects.instances.databases.sessions.rollback",
+ "path": "v1/{+session}: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`."
+ },
+ "streamingRead": {
+ "httpMethod": "POST",
+ "parameterOrder": [
+ "session"
+ ],
+ "response": {
+ "$ref": "PartialResultSet"
+ },
+ "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"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
+ "id": "spanner.projects.instances.databases.sessions.streamingRead",
+ "path": "v1/{+session}:streamingRead",
+ "request": {
+ "$ref": "ReadRequest"
+ },
+ "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB."
+ },
+ "create": {
+ "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\nwhich no operations are sent for more than an hour, or due to\ninternal errors. If a session is deleted, requests to it\nreturn `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
+ "response": {
+ "$ref": "Session"
+ },
+ "parameterOrder": [
+ "database"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "database": {
+ "description": "Required. The database in which the new session is created.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions"
+ }
+ }
+ }
+ }
+ },
+ "operations": {
+ "methods": {
+ "cancel": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
+ "path": "v1/{+name}:cancel",
+ "id": "spanner.projects.instances.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
+ },
+ "delete": {
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be deleted.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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`."
+ },
+ "list": {
+ "response": {
+ "$ref": "ListOperationsResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation collection.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/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"
+ }
+ },
+ "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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/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.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
+ "id": "spanner.projects.instances.operations.get",
+ "path": "v1/{+name}"
+ }
+ }
+ }
+ },
+ "methods": {
+ "delete": {
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.delete",
+ "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted."
+ },
+ "list": {
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.list",
+ "description": "Lists all instances in the given project.",
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListInstancesResponse"
+ },
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string"
+ },
+ "filter": {
+ "location": "query",
+ "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
+ "type": "string"
+ },
+ "pageSize": {
+ "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",
+ "location": "query"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances"
+ },
+ "setIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "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.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
+ "path": "v1/{+resource}:setIamPolicy",
+ "id": "spanner.projects.instances.setIamPolicy",
+ "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.",
+ "request": {
+ "$ref": "SetIamPolicyRequest"
+ }
+ },
+ "create": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "parameters": {
+ "parent": {
+ "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instances",
+ "path": "v1/{+parent}/instances",
+ "id": "spanner.projects.instances.create",
+ "request": {
+ "$ref": "CreateInstanceRequest"
+ },
+ "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful."
+ },
+ "getIamPolicy": {
+ "response": {
+ "$ref": "Policy"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "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",
+ "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.",
+ "request": {
+ "$ref": "GetIamPolicyRequest"
+ }
+ },
+ "get": {
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.get",
+ "description": "Gets information about a particular instance.",
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "Instance"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}"
+ },
+ "patch": {
+ "response": {
+ "$ref": "Operation"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "PATCH",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
+ "path": "v1/{+name}",
+ "id": "spanner.projects.instances.patch",
+ "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name.",
+ "request": {
+ "$ref": "UpdateInstanceRequest"
+ }
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.",
+ "request": {
+ "$ref": "TestIamPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestIamPermissionsResponse"
+ },
+ "parameterOrder": [
+ "resource"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "parameters": {
+ "resource": {
+ "pattern": "^projects/[^/]+/instances/[^/]+$",
+ "location": "path",
+ "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
+ "path": "v1/{+resource}:testIamPermissions",
+ "id": "spanner.projects.instances.testIamPermissions"
+ }
+ }
+ },
+ "instanceConfigs": {
+ "methods": {
+ "list": {
+ "description": "Lists the supported instance configurations for a given project.",
+ "response": {
+ "$ref": "ListInstanceConfigsResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "parent": {
+ "pattern": "^projects/[^/]+$",
+ "location": "path",
+ "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs",
+ "path": "v1/{+parent}/instanceConfigs",
+ "id": "spanner.projects.instanceConfigs.list"
+ },
+ "get": {
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "InstanceConfig"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform"
+ ],
+ "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
+ "id": "spanner.projects.instanceConfigs.get",
+ "path": "v1/{+name}",
+ "description": "Gets information about a particular instance configuration."
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "location": "query",
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true",
+ "location": "query"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "callback": {
+ "description": "JSONP",
+ "type": "string",
+ "location": "query"
+ },
+ "$.xgafv": {
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query"
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "location": "query",
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "location": "query",
+ "description": "OAuth bearer token.",
+ "type": "string"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "type": "string",
+ "location": "query"
+ }
+ },
+ "version": "v1",
+ "baseUrl": "https://spanner.googleapis.com/",
+ "kind": "discovery#restDescription",
+ "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
+ "servicePath": "",
+ "basePath": "",
+ "documentationLink": "https://cloud.google.com/spanner/",
+ "id": "spanner:v1",
+ "revision": "20170214",
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
- }
- },
- "code": {
- "description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32",
- "type": "integer"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
- }
- },
- "id": "Status"
- },
- "ResultSet": {
- "description": "Results from Read or\nExecuteSql.",
- "type": "object",
- "properties": {
- "stats": {
- "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": {
- "description": "Metadata about the result set, such as row type information.",
- "$ref": "ResultSetMetadata"
- }
- },
- "id": "ResultSet"
- },
- "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* `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"
- },
- "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"
- },
- "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": {
- "$ref": "ResultSetMetadata",
- "description": "Metadata about the result set, such as row type information.\nOnly present in the first response."
- },
- "values": {
- "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
- "type": "array",
- "items": {
- "type": "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",
- "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": {
- "properties": {
- "nextPageToken": {
- "description": "The standard List next-page token.",
- "type": "string"
- },
- "operations": {
- "description": "A list of operations that matches the specified filter in the request.",
- "type": "array",
- "items": {
- "$ref": "Operation"
- }
- }
- },
- "id": "ListOperationsResponse",
- "description": "The response message for Operations.ListOperations.",
- "type": "object"
- },
- "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": {
- "rowType": {
- "$ref": "StructType",
- "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]"
- },
- "transaction": {
- "$ref": "Transaction",
- "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here."
- }
- },
- "id": "ResultSetMetadata"
- },
- "TransactionSelector": {
- "properties": {
- "singleUse": {
- "$ref": "TransactionOptions",
- "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query."
- },
- "begin": {
- "$ref": "TransactionOptions",
- "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction."
- },
- "id": {
- "description": "Execute the read or SQL query in a previously-started transaction.",
- "format": "byte",
- "type": "string"
- }
- },
- "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": {
- "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": {
- "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`.",
- "$ref": "Write"
- },
- "delete": {
- "$ref": "Delete",
- "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
- },
- "insert": {
- "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.",
- "$ref": "Write"
- },
- "insertOrUpdate": {
- "$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",
- "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",
- "type": "object"
- },
- "KeySet": {
- "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
- "type": "object",
- "properties": {
- "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"
- },
- "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": {
- "enum": [
- "STATE_UNSPECIFIED",
- "CREATING",
- "READY"
- ],
- "description": "Output only. The current database 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."
- ]
- },
- "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": {
- "properties": {
- "nodeCount": {
- "description": "Required. The number of nodes allocated to this instance.",
- "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",
- "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
- "type": "object"
- },
- "SetIamPolicyRequest": {
- "properties": {
- "policy": {
- "$ref": "Policy",
- "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
- },
- "updateMask": {
- "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "id": "SetIamPolicyRequest",
- "description": "Request message for `SetIamPolicy` method.",
- "type": "object"
- },
- "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"
- },
- "RollbackRequest": {
- "properties": {
- "transactionId": {
- "description": "Required. The transaction to roll back.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "RollbackRequest",
- "description": "The request for Rollback.",
- "type": "object"
- },
- "Transaction": {
- "description": "A transaction.",
- "type": "object",
- "properties": {
- "readTimestamp": {
- "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "id": {
- "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.",
- "format": "byte",
- "type": "string"
- }
- },
- "id": "Transaction"
- },
- "UpdateDatabaseDdlMetadata": {
- "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.",
- "type": "object",
- "properties": {
- "database": {
- "description": "The database being modified.",
- "type": "string"
- },
- "statements": {
- "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "commitTimestamps": {
- "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.",
- "type": "array",
- "items": {
- "format": "google-datetime",
- "type": "string"
- }
- }
- },
- "id": "UpdateDatabaseDdlMetadata"
- },
- "CounterOptions": {
- "properties": {
- "metric": {
- "description": "The metric to update.",
- "type": "string"
- },
- "field": {
- "description": "The field value to attribute.",
- "type": "string"
- }
- },
- "id": "CounterOptions",
- "description": "Options for counters",
- "type": "object"
- },
- "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",
@@ -486,25 +1194,6 @@
},
"id": "Field"
},
- "ResultSetStats": {
- "properties": {
- "queryStats": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }",
- "type": "object"
- },
- "queryPlan": {
- "$ref": "QueryPlan",
- "description": "QueryPlan for the query associated with this result."
- }
- },
- "id": "ResultSetStats",
- "description": "Additional statistics about a ResultSet or PartialResultSet.",
- "type": "object"
- },
"TestIamPermissionsRequest": {
"properties": {
"permissions": {
@@ -519,7 +1208,28 @@
"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.",
@@ -527,23 +1237,31 @@
"type": "string"
}
},
- "id": "CommitResponse",
- "description": "The response for Commit.",
- "type": "object"
+ "id": "CommitResponse"
},
"Type": {
- "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.",
- "type": "object",
"properties": {
"structType": {
- "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields.",
- "$ref": "StructType"
+ "$ref": "StructType",
+ "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields."
},
"arrayElementType": {
"$ref": "Type",
"description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements."
},
"code": {
+ "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",
@@ -557,47 +1275,17 @@
"STRUCT"
],
"description": "Required. The TypeCode for this type.",
- "type": "string",
- "enumDescriptions": [
- "Not specified.",
- "Encoded as JSON `true` or `false`.",
- "Encoded as `string`, in decimal format.",
- "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.",
- "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.",
- "Encoded as `string` in RFC 3339 date format.",
- "Encoded as `string`.",
- "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.",
- "Encoded as `list`, where the list elements are represented\naccording to array_element_type.",
- "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]."
- ]
+ "type": "string"
}
},
- "id": "Type"
+ "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": {
- "$ref": "ShortRepresentation",
- "description": "Condensed representation for SCALAR nodes."
- },
"index": {
"description": "The `PlanNode`'s index in node list.",
"format": "int32",
@@ -627,36 +1315,33 @@
"items": {
"$ref": "ChildLink"
}
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }",
+ "type": "object"
+ },
+ "executionStats": {
+ "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"
},
- "AuditConfig": {
- "properties": {
- "service": {
- "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
- "type": "string"
- },
- "auditLogConfigs": {
- "description": "The configuration for logging of each type of permission.\nNext ID: 4",
- "type": "array",
- "items": {
- "$ref": "AuditLogConfig"
- }
- },
- "exemptedMembers": {
- "description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.\nThis field is deprecated in favor of per-permission-type exemptions.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- "id": "AuditConfig",
- "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.",
- "type": "object"
- },
"CreateInstanceMetadata": {
+ "description": "Metadata type for the operation returned by\nCreateInstance.",
+ "type": "object",
"properties": {
"instance": {
"description": "The instance being created.",
@@ -678,11 +1363,36 @@
"type": "string"
}
},
- "id": "CreateInstanceMetadata",
- "description": "Metadata type for the operation returned by\nCreateInstance.",
+ "id": "CreateInstanceMetadata"
+ },
+ "AuditConfig": {
+ "properties": {
+ "exemptedMembers": {
+ "description": "Specifies the identities that are exempted from \"data access\" audit\nlogging for the `service` specified above.\nFollows the same format of Binding.members.\nThis field is deprecated in favor of per-permission-type exemptions.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "service": {
+ "description": "Specifies a service that will be enabled for audit logging.\nFor example, `resourcemanager`, `storage`, `compute`.\n`allServices` is a special value that covers all services.",
+ "type": "string"
+ },
+ "auditLogConfigs": {
+ "description": "The configuration for logging of each type of permission.\nNext ID: 4",
+ "type": "array",
+ "items": {
+ "$ref": "AuditLogConfig"
+ }
+ }
+ },
+ "id": "AuditConfig",
+ "description": "Specifies the audit configuration for a service.\nIt consists of which permission types are logged, and what identities, if\nany, are exempted from logging.\nAn AuditConifg must have one or more AuditLogConfigs.",
"type": "object"
},
"ChildLink": {
+ "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
+ "type": "object",
"properties": {
"type": {
"description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.",
@@ -698,9 +1408,7 @@
"type": "string"
}
},
- "id": "ChildLink",
- "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.",
- "type": "object"
+ "id": "ChildLink"
},
"CloudAuditOptions": {
"description": "Write a Cloud Audit log",
@@ -723,6 +1431,17 @@
"description": "Arguments to delete operations.",
"type": "object"
},
+ "BeginTransactionRequest": {
+ "description": "The request for BeginTransaction.",
+ "type": "object",
+ "properties": {
+ "options": {
+ "$ref": "TransactionOptions",
+ "description": "Required. Options for the new transaction."
+ }
+ },
+ "id": "BeginTransactionRequest"
+ },
"CommitRequest": {
"description": "The request for Commit.",
"type": "object",
@@ -746,17 +1465,6 @@
},
"id": "CommitRequest"
},
- "BeginTransactionRequest": {
- "description": "The request for BeginTransaction.",
- "type": "object",
- "properties": {
- "options": {
- "description": "Required. Options for the new transaction.",
- "$ref": "TransactionOptions"
- }
- },
- "id": "BeginTransactionRequest"
- },
"ListInstanceConfigsResponse": {
"properties": {
"nextPageToken": {
@@ -807,7 +1515,27 @@
"type": "object"
},
"Rule": {
+ "description": "A rule to be applied in a Policy.",
+ "type": "object",
"properties": {
+ "notIn": {
+ "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "description": {
+ "description": "Human-readable description of the rule.",
+ "type": "string"
+ },
+ "conditions": {
+ "description": "Additional restrictions that must be met",
+ "type": "array",
+ "items": {
+ "$ref": "Condition"
+ }
+ },
"logConfig": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries\nthat match the LOG action.",
"type": "array",
@@ -830,6 +1558,14 @@
}
},
"action": {
+ "enumDescriptions": [
+ "Default no action.",
+ "Matching 'Entries' grant access.",
+ "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' deny access.",
+ "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
+ "Matching 'Entries' tell IAM.Check callers to generate logs."
+ ],
"enum": [
"NO_ACTION",
"ALLOW",
@@ -839,38 +1575,10 @@
"LOG"
],
"description": "Required",
- "type": "string",
- "enumDescriptions": [
- "Default no action.",
- "Matching 'Entries' grant access.",
- "Matching 'Entries' grant access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' deny access.",
- "Matching 'Entries' deny access and the caller promises to log\nthe request per the returned log_configs.",
- "Matching 'Entries' tell IAM.Check callers to generate logs."
- ]
- },
- "notIn": {
- "description": "If one or more 'not_in' clauses are specified, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.\nThe format for in and not_in entries is the same as for members in a\nBinding (see google/iam/v1/policy.proto).",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "description": {
- "description": "Human-readable description of the rule.",
"type": "string"
- },
- "conditions": {
- "description": "Additional restrictions that must be met",
- "type": "array",
- "items": {
- "$ref": "Condition"
- }
}
},
- "id": "Rule",
- "description": "A rule to be applied in a Policy.",
- "type": "object"
+ "id": "Rule"
},
"LogConfig": {
"properties": {
@@ -879,12 +1587,12 @@
"$ref": "CloudAuditOptions"
},
"counter": {
- "description": "Counter options.",
- "$ref": "CounterOptions"
+ "$ref": "CounterOptions",
+ "description": "Counter options."
},
"dataAccess": {
- "$ref": "DataAccessOptions",
- "description": "Data access options."
+ "description": "Data access options.",
+ "$ref": "DataAccessOptions"
}
},
"id": "LogConfig",
@@ -902,24 +1610,6 @@
"description": "A session in the Cloud Spanner API.",
"type": "object"
},
- "ListInstancesResponse": {
- "description": "The response for ListInstances.",
- "type": "object",
- "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"
- },
"KeyRange": {
"properties": {
"endClosed": {
@@ -955,10 +1645,26 @@
"description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.",
"type": "object"
},
- "ShortRepresentation": {
- "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
+ "ListInstancesResponse": {
+ "description": "The response for ListInstances.",
"type": "object",
"properties": {
+ "nextPageToken": {
+ "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.",
+ "type": "string"
+ },
+ "instances": {
+ "description": "The list of requested instances.",
+ "type": "array",
+ "items": {
+ "$ref": "Instance"
+ }
+ }
+ },
+ "id": "ListInstancesResponse"
+ },
+ "ShortRepresentation": {
+ "properties": {
"description": {
"description": "A string representation of the expression subtree rooted at this node.",
"type": "string"
@@ -972,7 +1678,9 @@
"type": "object"
}
},
- "id": "ShortRepresentation"
+ "id": "ShortRepresentation",
+ "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).",
+ "type": "object"
},
"InstanceConfig": {
"properties": {
@@ -990,8 +1698,6 @@
"type": "object"
},
"UpdateInstanceRequest": {
- "description": "The request for UpdateInstance.",
- "type": "object",
"properties": {
"instance": {
"$ref": "Instance",
@@ -1003,7 +1709,9 @@
"type": "string"
}
},
- "id": "UpdateInstanceRequest"
+ "id": "UpdateInstanceRequest",
+ "description": "The request for UpdateInstance.",
+ "type": "object"
},
"Empty": {
"properties": {},
@@ -1012,32 +1720,32 @@
"type": "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."
+ "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource.",
+ "$ref": "ReadOnly"
}
},
- "id": "TransactionOptions"
+ "id": "TransactionOptions",
+ "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.",
+ "type": "object"
},
"CreateDatabaseRequest": {
"properties": {
+ "createStatement": {
+ "description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.",
+ "type": "string"
+ },
"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.",
"type": "array",
"items": {
"type": "string"
}
- },
- "createStatement": {
- "description": "Required. A `CREATE DATABASE` statement, which specifies the ID of the\nnew database. The database ID must conform to the regular expression\n`a-z*[a-z0-9]` and be between 2 and 30 characters in length.",
- "type": "string"
}
},
"id": "CreateDatabaseRequest",
@@ -1045,22 +1753,65 @@
"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`."
+ },
"instanceId": {
"description": "Required. The ID of the instance to create. Valid identifiers are of the\nform `a-z*[a-z0-9]` and must be between 6 and 30 characters in\nlength.",
"type": "string"
- },
- "instance": {
- "description": "Required. The instance to create. The name may be omitted, but if\nspecified must be `\u003cparent\u003e/instances/\u003cinstance_id\u003e`.",
- "$ref": "Instance"
}
},
- "id": "CreateInstanceRequest"
+ "id": "CreateInstanceRequest",
+ "description": "The request for CreateInstance.",
+ "type": "object"
},
"Condition": {
"properties": {
+ "values": {
+ "description": "The objects of the condition. This is mutually exclusive with 'value'.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "iam": {
+ "enumDescriptions": [
+ "Default non-attribute.",
+ "Either principal or (if present) authority selector.",
+ "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
+ "Any of the security realms in the IAMContext (go/security-realms).\nWhen used with IN, the condition indicates \"any of the request's realms\nmatch one of the given values; with NOT_IN, \"none of the realms match\nany of the given values\". It is not permitted to grant access based on\nthe *absence* of a realm, so realm conditions can only be used in\na \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN)."
+ ],
+ "enum": [
+ "NO_ATTR",
+ "AUTHORITY",
+ "ATTRIBUTION",
+ "SECURITY_REALM"
+ ],
+ "description": "Trusted attributes supplied by the IAM system.",
+ "type": "string"
+ },
+ "op": {
+ "enumDescriptions": [
+ "Default no-op.",
+ "DEPRECATED. Use IN instead.",
+ "DEPRECATED. Use NOT_IN instead.",
+ "Set-inclusion check.",
+ "Set-exclusion check.",
+ "Subject is discharged"
+ ],
+ "enum": [
+ "NO_OP",
+ "EQUALS",
+ "NOT_EQUALS",
+ "IN",
+ "NOT_IN",
+ "DISCHARGED"
+ ],
+ "description": "An operator to apply the subject with.",
+ "type": "string"
+ },
"svc": {
"description": "Trusted attributes discharged by the service.",
"type": "string"
@@ -1086,49 +1837,6 @@
],
"description": "Trusted attributes supplied by any service that owns resources and uses\nthe IAM system for access control.",
"type": "string"
- },
- "values": {
- "description": "The objects of the condition. This is mutually exclusive with 'value'.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "iam": {
- "enumDescriptions": [
- "Default non-attribute.",
- "Either principal or (if present) authority selector.",
- "The principal (even if an authority selector is present), which\nmust only be used for attribution, not authorization.",
- "Any of the security realms in the IAMContext (go/security-realms).\nWhen used with IN, the condition indicates \"any of the request's realms\nmatch one of the given values; with NOT_IN, \"none of the realms match\nany of the given values\". It is not permitted to grant access based on\nthe *absence* of a realm, so realm conditions can only be used in\na \"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN)."
- ],
- "enum": [
- "NO_ATTR",
- "AUTHORITY",
- "ATTRIBUTION",
- "SECURITY_REALM"
- ],
- "description": "Trusted attributes supplied by the IAM system.",
- "type": "string"
- },
- "op": {
- "enum": [
- "NO_OP",
- "EQUALS",
- "NOT_EQUALS",
- "IN",
- "NOT_IN",
- "DISCHARGED"
- ],
- "description": "An operator to apply the subject with.",
- "type": "string",
- "enumDescriptions": [
- "Default no-op.",
- "DEPRECATED. Use IN instead.",
- "DEPRECATED. Use NOT_IN instead.",
- "Set-inclusion check.",
- "Set-exclusion check.",
- "Subject is discharged"
- ]
}
},
"id": "Condition",
@@ -1201,13 +1909,7 @@
"id": "ReadOnly"
},
"ExecuteSqlRequest": {
- "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
- "type": "object",
"properties": {
- "sql": {
- "description": "Required. The SQL query string.",
- "type": "string"
- },
"params": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -1217,18 +1919,18 @@
"type": "object"
},
"queryMode": {
+ "enumDescriptions": [
+ "The default mode where only the query result, without any information\nabout the query plan is returned.",
+ "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
+ "This mode returns both the query plan and the execution statistics along\nwith the result rows."
+ ],
"enum": [
"NORMAL",
"PLAN",
"PROFILE"
],
"description": "Used to control the amount of debugging information returned in\nResultSetStats.",
- "type": "string",
- "enumDescriptions": [
- "The default mode where only the query result, without any information\nabout the query plan is returned.",
- "This mode returns only the query plan, without any result rows or\nexecution statistics information.",
- "This mode returns both the query plan and the execution statistics along\nwith the result rows."
- ]
+ "type": "string"
},
"transaction": {
"$ref": "TransactionSelector",
@@ -1245,12 +1947,35 @@
},
"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"
+ "id": "ExecuteSqlRequest",
+ "description": "The request for ExecuteSql and\nExecuteStreamingSql.",
+ "type": "object"
},
"Policy": {
+ "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).",
+ "type": "object",
"properties": {
+ "etag": {
+ "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
+ "format": "byte",
+ "type": "string"
+ },
+ "iamOwned": {
+ "type": "boolean"
+ },
+ "rules": {
+ "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
+ "type": "array",
+ "items": {
+ "$ref": "Rule"
+ }
+ },
"version": {
"description": "Version of the `Policy`. The default version is 0.",
"format": "int32",
@@ -1269,26 +1994,9 @@
"items": {
"$ref": "Binding"
}
- },
- "etag": {
- "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.",
- "format": "byte",
- "type": "string"
- },
- "iamOwned": {
- "type": "boolean"
- },
- "rules": {
- "description": "If more than one rule is specified, the rules are applied in the following\nmanner:\n- All matching LOG rules are always applied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging will be applied if one or more matching rule requires logging.\n- Otherwise, if no rule applies, permission is denied.",
- "type": "array",
- "items": {
- "$ref": "Rule"
- }
}
},
- "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": {
@@ -1313,8 +2021,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.",
@@ -1365,19 +2073,13 @@
"id": "DataAccessOptions"
},
"ReadWrite": {
- "properties": {},
- "id": "ReadWrite",
"description": "Options for read-write transactions.",
- "type": "object"
+ "type": "object",
+ "properties": {},
+ "id": "ReadWrite"
},
"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.",
@@ -1401,15 +2103,490 @@
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
}
},
- "id": "Operation"
+ "id": "Operation",
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object"
+ },
+ "ResultSet": {
+ "properties": {
+ "rows": {
+ "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.",
+ "$ref": "ResultSetMetadata"
+ },
+ "stats": {
+ "$ref": "ResultSetStats",
+ "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode."
+ }
+ },
+ "id": "ResultSet",
+ "description": "Results from Read or\nExecuteSql.",
+ "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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "id": "Status"
+ },
+ "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* `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": {
+ "properties": {
+ "resumeToken": {
+ "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.",
+ "format": "byte",
+ "type": "string"
+ },
+ "stats": {
+ "$ref": "ResultSetStats",
+ "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream."
+ },
+ "chunkedValue": {
+ "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.",
+ "$ref": "ResultSetMetadata"
+ },
+ "values": {
+ "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.",
+ "type": "array",
+ "items": {
+ "type": "any"
+ }
+ }
+ },
+ "id": "PartialResultSet",
+ "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.",
+ "type": "object"
+ },
+ "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": {
+ "description": "Metadata type for the operation returned by\nUpdateInstance.",
+ "type": "object",
+ "properties": {
+ "cancelTime": {
+ "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "endTime": {
+ "description": "The time at which this operation failed or was completed successfully.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "instance": {
+ "$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"
+ },
+ "ResultSetMetadata": {
+ "properties": {
+ "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"
+ },
+ "transaction": {
+ "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here.",
+ "$ref": "Transaction"
+ }
+ },
+ "id": "ResultSetMetadata",
+ "description": "Metadata about a ResultSet or PartialResultSet.",
+ "type": "object"
+ },
+ "TransactionSelector": {
+ "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "Mutation": {
+ "properties": {
+ "delete": {
+ "$ref": "Delete",
+ "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present."
+ },
+ "insert": {
+ "$ref": "Write",
+ "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`."
+ },
+ "insertOrUpdate": {
+ "$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": {
+ "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`.",
+ "$ref": "Write"
+ },
+ "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",
+ "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.",
+ "type": "object"
+ },
+ "KeySet": {
+ "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.",
+ "type": "object",
+ "properties": {
+ "ranges": {
+ "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.",
+ "type": "array",
+ "items": {
+ "$ref": "KeyRange"
+ }
+ },
+ "keys": {
+ "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.",
+ "type": "array",
+ "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"
+ }
+ },
+ "id": "KeySet"
+ },
+ "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": {
+ "properties": {
+ "state": {
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "CREATING",
+ "READY"
+ ],
+ "description": "Output only. The current database 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."
+ ]
+ },
+ "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",
+ "description": "A Cloud Spanner database.",
+ "type": "object"
+ },
+ "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": {
+ "updateMask": {
+ "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, a default\nmask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.",
+ "format": "google-fieldmask",
+ "type": "string"
+ },
+ "policy": {
+ "$ref": "Policy",
+ "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
+ }
+ },
+ "id": "SetIamPolicyRequest"
+ },
+ "Instance": {
+ "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.",
+ "type": "object",
+ "properties": {
+ "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"
+ },
+ "nodeCount": {
+ "description": "Required. The number of nodes allocated to this instance.",
+ "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"
+ }
+ },
+ "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": {
+ "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": {
+ "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"
+ }
+ },
+ "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"
+ },
+ "CounterOptions": {
+ "description": "Options for counters",
+ "type": "object",
+ "properties": {
+ "metric": {
+ "description": "The metric to update.",
+ "type": "string"
+ },
+ "field": {
+ "description": "The field value to attribute.",
+ "type": "string"
+ }
+ },
+ "id": "CounterOptions"
+ },
+ "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": {
+ "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",
+ "description": "`StructType` defines the fields of a STRUCT type.",
+ "type": "object"
}
},
"protocol": "rest",
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"canonicalName": "Spanner",
"auth": {
@@ -1426,1182 +2603,5 @@
"name": "spanner",
"batchPath": "batch",
"title": "Cloud Spanner API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "instanceConfigs": {
- "methods": {
- "list": {
- "description": "Lists the supported instance configurations for a given project.",
- "response": {
- "$ref": "ListInstanceConfigsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instanceConfigs",
- "path": "v1/{+parent}/instanceConfigs",
- "id": "spanner.projects.instanceConfigs.list"
- },
- "get": {
- "description": "Gets information about a particular instance configuration.",
- "response": {
- "$ref": "InstanceConfig"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instanceConfigs.get"
- }
- }
- },
- "instances": {
- "methods": {
- "delete": {
- "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.delete"
- },
- "list": {
- "description": "Lists all instances in the given project.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListInstancesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- },
- "filter": {
- "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * name\n * display_name\n * labels.key where key is the name of a label\n\nSome examples of using filters are:\n\n * name:* --\u003e The instance has a name.\n * name:Howl --\u003e The instance's name contains the string \"howl\".\n * name:HOWL --\u003e Equivalent to above.\n * NAME:howl --\u003e Equivalent to above.\n * labels.env:* --\u003e The instance has the label \"env\".\n * labels.env:dev --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * name:howl labels.env:dev --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.list",
- "path": "v1/{+parent}/instances"
- },
- "setIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "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.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "id": "spanner.projects.instances.setIamPolicy",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource."
- },
- "create": {
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances",
- "id": "spanner.projects.instances.create",
- "path": "v1/{+parent}/instances",
- "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"
- }
- },
- "getIamPolicy": {
- "response": {
- "$ref": "Policy"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- },
- "get": {
- "response": {
- "$ref": "Instance"
- },
- "parameterOrder": [
- "name"
- ],
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.get",
- "description": "Gets information about a particular instance."
- },
- "patch": {
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.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."
- },
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions",
- "path": "v1/{+resource}:testIamPermissions",
- "id": "spanner.projects.instances.testIamPermissions"
- }
- },
- "resources": {
- "databases": {
- "methods": {
- "getDdl": {
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "GetDatabaseDdlResponse"
- },
- "parameters": {
- "database": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "Required. The database whose schema we wish to get.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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": {
- "id": "spanner.projects.instances.databases.list",
- "path": "v1/{+parent}/databases",
- "description": "Lists Cloud Spanner databases.",
- "httpMethod": "GET",
- "response": {
- "$ref": "ListDatabasesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "pageToken": {
- "location": "query",
- "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.",
- "type": "string"
- },
- "pageSize": {
- "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.",
- "format": "int32",
- "type": "integer",
- "location": "query"
- },
- "parent": {
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases"
- },
- "create": {
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "parent": {
- "pattern": "^projects/[^/]+/instances/[^/]+$",
- "location": "path",
- "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases",
- "path": "v1/{+parent}/databases",
- "id": "spanner.projects.instances.databases.create",
- "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.",
- "request": {
- "$ref": "CreateDatabaseRequest"
- }
- },
- "setIamPolicy": {
- "id": "spanner.projects.instances.databases.setIamPolicy",
- "path": "v1/{+resource}:setIamPolicy",
- "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource.",
- "request": {
- "$ref": "SetIamPolicyRequest"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "Policy"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy"
- },
- "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"
- },
- "parameterOrder": [
- "resource"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy",
- "path": "v1/{+resource}:getIamPolicy",
- "id": "spanner.projects.instances.databases.getIamPolicy"
- },
- "get": {
- "response": {
- "$ref": "Database"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "id": "spanner.projects.instances.databases.get",
- "path": "v1/{+name}",
- "description": "Gets the state of a Cloud Spanner database."
- },
- "dropDatabase": {
- "description": "Drops (aka deletes) a Cloud Spanner database.",
- "response": {
- "$ref": "Empty"
- },
- "httpMethod": "DELETE",
- "parameterOrder": [
- "database"
- ],
- "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"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}",
- "path": "v1/{+database}",
- "id": "spanner.projects.instances.databases.dropDatabase"
- },
- "updateDdl": {
- "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"
- ],
- "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."
- },
- "testIamPermissions": {
- "httpMethod": "POST",
- "parameterOrder": [
- "resource"
- ],
- "response": {
- "$ref": "TestIamPermissionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "resource": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path",
- "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions",
- "id": "spanner.projects.instances.databases.testIamPermissions",
- "path": "v1/{+resource}: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"
- }
- }
- },
- "resources": {
- "operations": {
- "methods": {
- "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`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel"
- },
- "delete": {
- "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`.",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "DELETE",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}"
- },
- "list": {
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "description": "The name of the operation collection.",
- "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"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations",
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.list",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`."
- },
- "get": {
- "path": "v1/{+name}",
- "id": "spanner.projects.instances.databases.operations.get",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}"
- }
- }
- },
- "sessions": {
- "methods": {
- "delete": {
- "httpMethod": "DELETE",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "name": {
- "description": "Required. The name of the session to delete.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}",
- "id": "spanner.projects.instances.databases.sessions.delete",
- "path": "v1/{+name}",
- "description": "Ends a session, releasing server resources associated with it."
- },
- "executeStreamingSql": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "PartialResultSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
- "id": "spanner.projects.instances.databases.sessions.executeStreamingSql",
- "path": "v1/{+session}: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"
- }
- },
- "commit": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "CommitResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
- "id": "spanner.projects.instances.databases.sessions.commit",
- "path": "v1/{+session}:commit",
- "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.",
- "request": {
- "$ref": "CommitRequest"
- }
- },
- "beginTransaction": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "Transaction"
- },
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the transaction runs.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction",
- "id": "spanner.projects.instances.databases.sessions.beginTransaction",
- "path": "v1/{+session}: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."
- },
- "executeSql": {
- "path": "v1/{+session}:executeSql",
- "id": "spanner.projects.instances.databases.sessions.executeSql",
- "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.",
- "request": {
- "$ref": "ExecuteSqlRequest"
- },
- "response": {
- "$ref": "ResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "session": {
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path",
- "description": "Required. The session in which the SQL query should be performed.",
- "required": true,
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql"
- },
- "streamingRead": {
- "response": {
- "$ref": "PartialResultSet"
- },
- "parameterOrder": [
- "session"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "session": {
- "description": "Required. The session in which the read should be performed.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead",
- "path": "v1/{+session}:streamingRead",
- "id": "spanner.projects.instances.databases.sessions.streamingRead",
- "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.",
- "request": {
- "$ref": "ReadRequest"
- }
- },
- "rollback": {
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "session": {
- "description": "Required. The session in which the transaction to roll back is running.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback",
- "id": "spanner.projects.instances.databases.sessions.rollback",
- "path": "v1/{+session}: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": {
- "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\nwhich no operations are sent for more than an hour, or due to\ninternal errors. If a session is deleted, requests to it\nreturn `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.",
- "response": {
- "$ref": "Session"
- },
- "parameterOrder": [
- "database"
- ],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "parameters": {
- "database": {
- "description": "Required. The database in which the new session is created.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$",
- "location": "path"
- }
- },
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/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"
- },
- "httpMethod": "POST",
- "parameterOrder": [
- "session"
- ],
- "response": {
- "$ref": "ResultSet"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
- "id": "spanner.projects.instances.databases.sessions.read",
- "path": "v1/{+session}:read"
- },
- "get": {
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "GET",
- "response": {
- "$ref": "Session"
- },
- "parameters": {
- "name": {
- "description": "Required. The name of the session to retrieve.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "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."
- }
- }
- }
- }
- },
- "operations": {
- "methods": {
- "cancel": {
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel",
- "path": "v1/{+name}:cancel",
- "id": "spanner.projects.instances.operations.cancel",
- "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
- },
- "delete": {
- "httpMethod": "DELETE",
- "response": {
- "$ref": "Empty"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path",
- "description": "The name of the operation resource to be deleted.",
- "required": true,
- "type": "string"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "id": "spanner.projects.instances.operations.delete",
- "path": "v1/{+name}",
- "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
- },
- "list": {
- "id": "spanner.projects.instances.operations.list",
- "path": "v1/{+name}",
- "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListOperationsResponse"
- },
- "parameters": {
- "filter": {
- "location": "query",
- "description": "The standard list filter.",
- "type": "string"
- },
- "name": {
- "pattern": "^projects/[^/]+/instances/[^/]+/operations$",
- "location": "path",
- "description": "The name of the operation collection.",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "The standard list page token.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations"
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Operation"
- },
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$",
- "location": "path"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform"
- ],
- "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}",
- "id": "spanner.projects.instances.operations.get",
- "path": "v1/{+name}",
- "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
- }
- }
- }
- }
- }
- }
- }
- },
- "parameters": {
- "upload_protocol": {
- "location": "query",
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
- },
- "prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "fields": {
- "location": "query",
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "description": "Data format for response.",
- "default": "json"
- },
- "key": {
- "location": "query",
- "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "type": "string",
- "location": "query"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "type": "string",
- "location": "query"
- },
- "pp": {
- "location": "query",
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
- }
- },
- "version": "v1",
- "baseUrl": "https://spanner.googleapis.com/",
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.",
- "basePath": "",
- "revision": "20170214",
- "documentationLink": "https://cloud.google.com/spanner/",
- "id": "spanner:v1"
+ "ownerName": "Google"
}
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json
index c871d4b..ba8d57c 100644
--- a/speech/v1beta1/speech-api.json
+++ b/speech/v1beta1/speech-api.json
@@ -1,4 +1,10 @@
{
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "protocol": "rest",
+ "version": "v1beta1",
"baseUrl": "https://speech.googleapis.com/",
"auth": {
"oauth2": {
@@ -17,18 +23,17 @@
"ownerDomain": "google.com",
"name": "speech",
"batchPath": "batch",
- "revision": "20170303",
- "documentationLink": "https://cloud.google.com/speech/",
"id": "speech:v1beta1",
+ "documentationLink": "https://cloud.google.com/speech/",
+ "revision": "20170303",
"title": "Google Cloud Speech API",
- "ownerName": "Google",
"discoveryVersion": "v1",
+ "ownerName": "Google",
"version_module": "True",
"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"
},
@@ -36,31 +41,31 @@
"name"
],
"httpMethod": "POST",
- "parameters": {
- "name": {
- "description": "The name of the operation resource to be cancelled.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$",
- "location": "path"
- }
- },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource to be cancelled."
+ }
+ },
"flatPath": "v1beta1/operations/{operationsId}:cancel",
"path": "v1beta1/operations/{+name}:cancel",
- "id": "speech.operations.cancel"
+ "id": "speech.operations.cancel",
+ "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`."
},
"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"
- },
+ "httpMethod": "DELETE",
"parameterOrder": [
"name"
],
- "httpMethod": "DELETE",
+ "response": {
+ "$ref": "Empty"
+ },
"parameters": {
"name": {
"location": "path",
@@ -74,8 +79,9 @@
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta1/operations/{operationsId}",
+ "id": "speech.operations.delete",
"path": "v1beta1/operations/{+name}",
- "id": "speech.operations.delete"
+ "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`."
},
"list": {
"response": {
@@ -84,26 +90,26 @@
"parameterOrder": [],
"httpMethod": "GET",
"parameters": {
- "pageSize": {
- "location": "query",
- "description": "The standard list page size.",
- "format": "int32",
- "type": "integer"
- },
- "filter": {
- "description": "The standard list filter.",
- "type": "string",
- "location": "query"
- },
"name": {
+ "location": "query",
"description": "The name of the operation collection.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"pageToken": {
+ "location": "query",
"description": "The standard list page token.",
- "type": "string",
- "location": "query"
+ "type": "string"
+ },
+ "pageSize": {
+ "type": "integer",
+ "location": "query",
+ "description": "The standard list page size.",
+ "format": "int32"
+ },
+ "filter": {
+ "location": "query",
+ "description": "The standard list filter.",
+ "type": "string"
}
},
"scopes": [
@@ -115,28 +121,28 @@
"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 below allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`."
},
"get": {
- "httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
- "parameters": {
- "name": {
- "location": "path",
- "description": "The name of the operation resource.",
- "required": true,
- "type": "string",
- "pattern": "^[^/]+$"
- }
- },
+ "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
+ "parameters": {
+ "name": {
+ "required": true,
+ "type": "string",
+ "pattern": "^[^/]+$",
+ "location": "path",
+ "description": "The name of the operation resource."
+ }
+ },
"flatPath": "v1beta1/operations/{operationsId}",
- "id": "speech.operations.get",
"path": "v1beta1/operations/{+name}",
+ "id": "speech.operations.get",
"description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice."
}
}
@@ -144,6 +150,9 @@
"speech": {
"methods": {
"asyncrecognize": {
+ "flatPath": "v1beta1/speech:asyncrecognize",
+ "id": "speech.speech.asyncrecognize",
+ "path": "v1beta1/speech:asyncrecognize",
"request": {
"$ref": "AsyncRecognizeRequest"
},
@@ -156,42 +165,76 @@
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ],
- "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",
+ "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
"request": {
"$ref": "SyncRecognizeRequest"
},
- "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.",
"response": {
"$ref": "SyncRecognizeResponse"
},
"parameterOrder": [],
"httpMethod": "POST",
- "parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
- ]
+ ],
+ "parameters": {},
+ "flatPath": "v1beta1/speech:syncrecognize",
+ "path": "v1beta1/speech:syncrecognize",
+ "id": "speech.speech.syncrecognize"
}
}
}
},
"parameters": {
- "bearer_token": {
+ "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": "OAuth bearer token.",
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ]
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "type": "string",
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token."
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string"
},
+ "pp": {
+ "type": "boolean",
+ "default": "true",
+ "location": "query",
+ "description": "Pretty-print response."
+ },
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
+ "type": "string"
+ },
+ "bearer_token": {
"type": "string",
- "location": "query"
+ "location": "query",
+ "description": "OAuth bearer token."
},
"upload_protocol": {
"location": "query",
@@ -199,27 +242,23 @@
"type": "string"
},
"prettyPrint": {
- "description": "Returns response with indentations and line breaks.",
"type": "boolean",
"default": "true",
- "location": "query"
+ "location": "query",
+ "description": "Returns response with indentations and line breaks."
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -229,132 +268,15 @@
"1",
"2"
],
- "description": "V1 error format.",
- "type": "string"
+ "description": "V1 error format."
},
- "alt": {
- "description": "Data format for response.",
- "default": "json",
- "enum": [
- "json",
- "media",
- "proto"
- ],
+ "callback": {
"type": "string",
- "enumDescriptions": [
- "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"
+ "description": "JSONP"
}
},
"schemas": {
- "Operation": {
- "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
- "type": "object",
- "properties": {
- "done": {
- "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
- "type": "boolean"
- },
- "response": {
- "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- },
- "name": {
- "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
- "type": "string"
- },
- "error": {
- "$ref": "Status",
- "description": "The error result of the operation in case of failure or cancellation."
- },
- "metadata": {
- "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
- },
- "id": "Operation"
- },
- "RecognitionConfig": {
- "description": "Provides information to the recognizer that specifies how to process the\nrequest.",
- "type": "object",
- "properties": {
- "maxAlternatives": {
- "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
- "format": "int32",
- "type": "integer"
- },
- "sampleRate": {
- "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
- "format": "int32",
- "type": "integer"
- },
- "languageCode": {
- "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
- "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`.",
- "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.",
- "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
- "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.",
- "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz."
- ],
- "enum": [
- "ENCODING_UNSPECIFIED",
- "LINEAR16",
- "FLAC",
- "MULAW",
- "AMR",
- "AMR_WB"
- ]
- },
- "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"
- },
- "speechContext": {
- "$ref": "SpeechContext",
- "description": "*Optional* A means to provide context to assist the speech recognition."
- }
- },
- "id": "RecognitionConfig"
- },
"SyncRecognizeRequest": {
"description": "The top-level message sent by the client for the `SyncRecognize` method.",
"type": "object",
@@ -370,20 +292,6 @@
},
"id": "SyncRecognizeRequest"
},
- "SyncRecognizeResponse": {
- "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.",
- "type": "object",
- "properties": {
- "results": {
- "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.",
- "type": "array",
- "items": {
- "$ref": "SpeechRecognitionResult"
- }
- }
- },
- "id": "SyncRecognizeResponse"
- },
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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",
@@ -392,11 +300,11 @@
"description": "A list of messages that carry the error details. There will be a\ncommon set of message types for APIs to use.",
"type": "array",
"items": {
+ "type": "object",
"additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- },
- "type": "object"
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ }
}
},
"code": {
@@ -411,11 +319,41 @@
},
"id": "Status"
},
+ "SyncRecognizeResponse": {
+ "type": "object",
+ "properties": {
+ "results": {
+ "type": "array",
+ "items": {
+ "$ref": "SpeechRecognitionResult"
+ },
+ "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio."
+ }
+ },
+ "id": "SyncRecognizeResponse",
+ "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages."
+ },
"Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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 `{}`."
+ },
+ "SpeechRecognitionAlternative": {
+ "type": "object",
+ "properties": {
+ "confidence": {
+ "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
+ "format": "float",
+ "type": "number"
+ },
+ "transcript": {
+ "type": "string",
+ "description": "*Output-only* Transcript text representing the words that the user spoke."
+ }
+ },
+ "id": "SpeechRecognitionAlternative",
+ "description": "Alternative hypotheses (a.k.a. n-best list)."
},
"SpeechContext": {
"description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.",
@@ -431,24 +369,7 @@
},
"id": "SpeechContext"
},
- "SpeechRecognitionAlternative": {
- "description": "Alternative hypotheses (a.k.a. n-best list).",
- "type": "object",
- "properties": {
- "confidence": {
- "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.",
- "format": "float",
- "type": "number"
- },
- "transcript": {
- "description": "*Output-only* Transcript text representing the words that the user spoke.",
- "type": "string"
- }
- },
- "id": "SpeechRecognitionAlternative"
- },
"ListOperationsResponse": {
- "description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
@@ -456,17 +377,17 @@
"type": "string"
},
"operations": {
- "description": "A list of operations that matches the specified filter in the request.",
"type": "array",
"items": {
"$ref": "Operation"
- }
+ },
+ "description": "A list of operations that matches the specified filter in the request."
}
},
- "id": "ListOperationsResponse"
+ "id": "ListOperationsResponse",
+ "description": "The response message for Operations.ListOperations."
},
"SpeechRecognitionResult": {
- "description": "A speech recognition result corresponding to a portion of the audio.",
"type": "object",
"properties": {
"alternatives": {
@@ -477,23 +398,8 @@
}
}
},
- "id": "SpeechRecognitionResult"
- },
- "RecognitionAudio": {
- "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
- "type": "object",
- "properties": {
- "content": {
- "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
- "format": "byte",
- "type": "string"
- },
- "uri": {
- "description": "URI that points to a file that contains audio data bytes as specified in\n`RecognitionConfig`. Currently, only Google Cloud Storage URIs are\nsupported, which must be specified in the following format:\n`gs://bucket_name/object_name` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](https://cloud.google.com/storage/docs/reference-uris).",
- "type": "string"
- }
- },
- "id": "RecognitionAudio"
+ "id": "SpeechRecognitionResult",
+ "description": "A speech recognition result corresponding to a portion of the audio."
},
"AsyncRecognizeRequest": {
"description": "The top-level message sent by the client for the `AsyncRecognize` method.",
@@ -504,17 +410,111 @@
"description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request."
},
"audio": {
- "description": "*Required* The audio data to be recognized.",
- "$ref": "RecognitionAudio"
+ "$ref": "RecognitionAudio",
+ "description": "*Required* The audio data to be recognized."
}
},
"id": "AsyncRecognizeRequest"
+ },
+ "RecognitionAudio": {
+ "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).",
+ "type": "object",
+ "properties": {
+ "content": {
+ "type": "string",
+ "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.",
+ "format": "byte"
+ },
+ "uri": {
+ "type": "string",
+ "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)."
+ }
+ },
+ "id": "RecognitionAudio"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
+ "type": "object",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "type": "any",
+ "description": "Properties of the object. Contains field @type with type URL."
+ },
+ "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress.\nIf true, the operation is completed, and either `error` or `response` is\navailable.",
+ "type": "boolean"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ }
+ },
+ "id": "Operation"
+ },
+ "RecognitionConfig": {
+ "type": "object",
+ "properties": {
+ "maxAlternatives": {
+ "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "sampleRate": {
+ "type": "integer",
+ "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).",
+ "format": "int32"
+ },
+ "languageCode": {
+ "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.",
+ "type": "string"
+ },
+ "profanityFilter": {
+ "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.",
+ "type": "boolean"
+ },
+ "speechContext": {
+ "$ref": "SpeechContext",
+ "description": "*Optional* A means to provide context to assist the speech recognition."
+ },
+ "encoding": {
+ "enum": [
+ "ENCODING_UNSPECIFIED",
+ "LINEAR16",
+ "FLAC",
+ "MULAW",
+ "AMR",
+ "AMR_WB"
+ ],
+ "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`.",
+ "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.",
+ "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.",
+ "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.",
+ "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz."
+ ]
+ }
+ },
+ "id": "RecognitionConfig",
+ "description": "Provides information to the recognizer that specifies how to process the\nrequest."
}
- },
- "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": "v1beta1"
+ }
}
diff --git a/tracing/v1/tracing-api.json b/tracing/v1/tracing-api.json
index b0309c6..0d45a23 100644
--- a/tracing/v1/tracing-api.json
+++ b/tracing/v1/tracing-api.json
@@ -1,44 +1,272 @@
{
- "kind": "discovery#restDescription",
- "description": "Send and retrieve trace data from Google Stackdriver Trace.\n",
+ "batchPath": "batch",
+ "title": "Google Tracing API",
+ "ownerName": "Google",
+ "resources": {
+ "projects": {
+ "resources": {
+ "traces": {
+ "methods": {
+ "list": {
+ "response": {
+ "$ref": "ListTracesResponse"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "orderBy": {
+ "location": "query",
+ "description": "Field used to sort the returned traces. Optional.\nCan be one of the following:\n\n* `trace_id`\n* `name` (`name` field of root span in the trace)\n* `duration` (difference between `end_time` and `start_time` fields of\n the root span)\n* `start` (`start_time` field of the root span)\n\nDescending order can be specified by appending `desc` to the sort field\n(for example, `name desc`).\n\nOnly one sort field is permitted.",
+ "type": "string"
+ },
+ "filter": {
+ "description": "An optional filter for the request.\nExample:\n\"version_label_key:a some_label:some_label_key\"\nreturns traces from version a and has some_label with some_label_key.",
+ "type": "string",
+ "location": "query"
+ },
+ "endTime": {
+ "location": "query",
+ "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "location": "query",
+ "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
+ "format": "google-datetime"
+ },
+ "pageSize": {
+ "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
+ "format": "int32",
+ "type": "integer",
+ "location": "query"
+ },
+ "parent": {
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$",
+ "location": "path"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/traces",
+ "path": "v1/{+parent}/traces",
+ "id": "tracing.projects.traces.list",
+ "description": "Returns of a list of traces that match the specified filter conditions."
+ },
+ "get": {
+ "description": "Returns a specific trace.",
+ "response": {
+ "$ref": "Trace"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "name": {
+ "location": "path",
+ "description": "ID of the trace which is \"projects/\u003cproject_id\u003e/traces/\u003ctrace_id\u003e\".",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+/traces/[^/]+$"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "flatPath": "v1/projects/{projectsId}/traces/{tracesId}",
+ "path": "v1/{+name}",
+ "id": "tracing.projects.traces.get"
+ },
+ "batchUpdate": {
+ "flatPath": "v1/projects/{projectsId}/traces:batchUpdate",
+ "path": "v1/{+parent}/traces:batchUpdate",
+ "id": "tracing.projects.traces.batchUpdate",
+ "description": "Sends new spans to Stackdriver Trace or updates existing spans. If the\nname of 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\nname does not match, a new trace is created with given set of spans.",
+ "request": {
+ "$ref": "BatchUpdateSpansRequest"
+ },
+ "response": {
+ "$ref": "Empty"
+ },
+ "parameterOrder": [
+ "parent"
+ ],
+ "httpMethod": "POST",
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.append"
+ ],
+ "parameters": {
+ "parent": {
+ "location": "path",
+ "description": "ID of the Cloud project where the trace data is stored.",
+ "required": true,
+ "type": "string",
+ "pattern": "^projects/[^/]+$"
+ }
+ }
+ },
+ "listSpans": {
+ "flatPath": "v1/projects/{projectsId}/traces/{tracesId}:listSpans",
+ "id": "tracing.projects.traces.listSpans",
+ "path": "v1/{+name}:listSpans",
+ "description": "Returns a list of spans within a trace.",
+ "httpMethod": "GET",
+ "response": {
+ "$ref": "ListSpansResponse"
+ },
+ "parameterOrder": [
+ "name"
+ ],
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/trace.readonly"
+ ],
+ "parameters": {
+ "name": {
+ "pattern": "^projects/[^/]+/traces/[^/]+$",
+ "location": "path",
+ "description": "ID of the span set where is \"projects/\u003cproject_id\u003e/traces/\u003ctrace_id\u003e\".",
+ "required": true,
+ "type": "string"
+ },
+ "pageToken": {
+ "location": "query",
+ "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `page_token` field from a previous request. Optional.",
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "type": "string",
+ "location": "query"
+ },
+ "prettyPrint": {
+ "location": "query",
+ "description": "Returns response with indentations and line breaks.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "fields": {
+ "location": "query",
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string"
+ },
+ "uploadType": {
+ "location": "query",
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "type": "string"
+ },
+ "callback": {
+ "location": "query",
+ "description": "JSONP",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "location": "query",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "description": "V1 error format.",
+ "type": "string",
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ]
+ },
+ "alt": {
+ "description": "Data format for response.",
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string",
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query"
+ },
+ "access_token": {
+ "type": "string",
+ "location": "query",
+ "description": "OAuth access token."
+ },
+ "key": {
+ "location": "query",
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string"
+ },
+ "quotaUser": {
+ "type": "string",
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ },
+ "pp": {
+ "location": "query",
+ "description": "Pretty-print response.",
+ "type": "boolean",
+ "default": "true"
+ },
+ "bearer_token": {
+ "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://tracing.googleapis.com/",
"servicePath": "",
+ "description": "Send and retrieve trace data from Google Stackdriver Trace.\n",
+ "kind": "discovery#restDescription",
"basePath": "",
- "id": "tracing:v1",
"documentationLink": "https://cloud.google.com/trace",
"revision": "20170225",
+ "id": "tracing:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "AttributeValue": {
- "description": "Allowed attribute values.",
- "type": "object",
- "properties": {
- "intValue": {
- "description": "An integer value.",
- "format": "int64",
- "type": "string"
- },
- "stringValue": {
- "description": "A string value.",
- "type": "string"
- },
- "boolValue": {
- "description": "A boolean value.",
- "type": "boolean"
- }
- },
- "id": "AttributeValue"
- },
"BatchUpdateSpansRequest": {
"description": "The request message for the `BatchUpdateSpans` method.",
"type": "object",
"properties": {
"spanUpdates": {
+ "description": "A map from trace name to spans to be stored or updated.",
"type": "object",
"additionalProperties": {
"$ref": "SpanUpdates"
- },
- "description": "A map from trace name to spans to be stored or updated."
+ }
}
},
"id": "BatchUpdateSpansRequest"
@@ -72,30 +300,66 @@
"type": "string"
},
"networkEvent": {
- "description": "Optional field that can be used only for network events.",
- "$ref": "NetworkEvent"
+ "$ref": "NetworkEvent",
+ "description": "Optional field that can be used only for network events."
},
"annotation": {
- "description": "Optional field for user supplied \u003cstring, AttributeValue\u003e map",
- "$ref": "Annotation"
+ "$ref": "Annotation",
+ "description": "Optional field for user supplied \u003cstring, AttributeValue\u003e map"
}
},
"id": "TimeEvent"
},
+ "NetworkEvent": {
+ "properties": {
+ "kernelTime": {
+ "description": "If available, this is the kernel time:\nFor sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the last bit was\nreceived.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "type": {
+ "enumDescriptions": [
+ "Unknown event.",
+ "Event type for sending RPC message.",
+ "Event type for receiving RPC message."
+ ],
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "SENT",
+ "RECV"
+ ],
+ "description": "Type of a NetworkEvent.",
+ "type": "string"
+ },
+ "messageId": {
+ "description": "Every message has an identifier, which must be different from all the\nnetwork messages in this span.\nThis is especially important when the request/response are streamed.",
+ "format": "uint64",
+ "type": "string"
+ },
+ "messageSize": {
+ "description": "Number of bytes send/receive.",
+ "format": "uint64",
+ "type": "string"
+ }
+ },
+ "id": "NetworkEvent",
+ "description": "An event describing an RPC message sent/received on the network.",
+ "type": "object"
+ },
"ListSpansResponse": {
"description": "The response message for the 'ListSpans' method.",
"type": "object",
"properties": {
- "nextPageToken": {
- "description": "If defined, indicates that there are more spans that match the request\nand that this value should be passed to the next request to continue\nretrieving additional spans.",
- "type": "string"
- },
"spans": {
"description": "The requested spans if they are any in the specified trace.",
"type": "array",
"items": {
"$ref": "Span"
}
+ },
+ "nextPageToken": {
+ "description": "If defined, indicates that there are more spans that match the request\nand that this value should be passed to the next request to continue\nretrieving additional spans.",
+ "type": "string"
}
},
"id": "ListSpansResponse"
@@ -114,63 +378,23 @@
}
}
},
- "NetworkEvent": {
- "description": "An event describing an RPC message sent/received on the network.",
- "type": "object",
- "properties": {
- "kernelTime": {
- "description": "If available, this is the kernel time:\nFor sent messages, this is the time at which the first bit was sent.\nFor received messages, this is the time at which the last bit was\nreceived.",
- "format": "google-datetime",
- "type": "string"
- },
- "type": {
- "description": "Type of a NetworkEvent.",
- "type": "string",
- "enumDescriptions": [
- "Unknown event.",
- "Event type for sending RPC message.",
- "Event type for receiving RPC message."
- ],
- "enum": [
- "TYPE_UNSPECIFIED",
- "SENT",
- "RECV"
- ]
- },
- "messageId": {
- "description": "Every message has an identifier, which must be different from all the\nnetwork messages in this span.\nThis is especially important when the request/response are streamed.",
- "format": "uint64",
- "type": "string"
- },
- "messageSize": {
- "description": "Number of bytes send/receive.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "NetworkEvent"
- },
"StackFrame": {
"description": "Presents a single stack frame in a stack trace.",
"type": "object",
"properties": {
- "functionName": {
- "description": "Fully qualified names which uniquely identify function/method/etc.",
- "type": "string"
- },
"lineNumber": {
+ "type": "string",
"description": "Line number of the frame.",
- "format": "int64",
- "type": "string"
+ "format": "int64"
},
"loadModule": {
"$ref": "Module",
"description": "Binary module the code is loaded from."
},
"columnNumber": {
- "type": "string",
"description": "Column number is important in JavaScript(anonymous functions),\nMight not be available in some languages.",
- "format": "int64"
+ "format": "int64",
+ "type": "string"
},
"fileName": {
"description": "File name of the frame.",
@@ -183,6 +407,10 @@
"originalFunctionName": {
"description": "Used when function name is ‘mangled’. Not guaranteed to be fully\nqualified but usually it is.",
"type": "string"
+ },
+ "functionName": {
+ "description": "Fully qualified names which uniquely identify function/method/etc.",
+ "type": "string"
}
},
"id": "StackFrame"
@@ -192,6 +420,7 @@
"type": "object",
"properties": {
"type": {
+ "type": "string",
"enumDescriptions": [
"The relation of current span and linked span is unknown.",
"Current span is child of the linked span.",
@@ -202,8 +431,7 @@
"CHILD",
"PARENT"
],
- "description": "The type of the link.",
- "type": "string"
+ "description": "The type of the link."
},
"traceId": {
"description": "The trace identifier of the linked span.",
@@ -226,11 +454,11 @@
"type": "string"
},
"attributes": {
+ "description": "A set of attributes on the annotation.",
+ "type": "object",
"additionalProperties": {
"$ref": "AttributeValue"
- },
- "description": "A set of attributes on the annotation.",
- "type": "object"
+ }
}
},
"id": "Annotation"
@@ -247,23 +475,28 @@
"id": "Trace"
},
"Module": {
- "id": "Module",
"description": "Binary module.",
"type": "object",
"properties": {
"module": {
- "description": "E.g. main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so",
- "type": "string"
+ "type": "string",
+ "description": "E.g. main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so"
},
"buildId": {
"description": "Build_id is a unique identifier for the module,\nusually a hash of its contents",
"type": "string"
}
- }
+ },
+ "id": "Module"
},
"Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
"type": "array",
@@ -276,47 +509,23 @@
}
},
"code": {
- "type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
- "format": "int32"
- },
- "message": {
- "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
- "type": "string"
+ "format": "int32",
+ "type": "integer"
}
},
- "id": "Status",
- "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\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"
},
"Span": {
"description": "A span represents a single operation 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 and, optionally, one or more subspans for\nits sub-operations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.",
"type": "object",
"properties": {
- "hasRemoteParent": {
- "type": "boolean",
- "description": "True if this Span has a remote parent (is an RPC server Span)."
- },
- "localEndTime": {
- "description": "Local machine clock time from the UNIX epoch,\nat which span execution ended.\nOn the server side these are the times when the server application\nhandler finishes running.",
- "format": "google-datetime",
- "type": "string"
- },
- "timeEvents": {
- "description": "A collection of time-stamped events.",
- "type": "array",
- "items": {
- "$ref": "TimeEvent"
- }
- },
- "parentId": {
- "description": "ID of parent span. 0 or missing if this is a root span.",
- "format": "uint64",
- "type": "string"
- },
- "status": {
- "$ref": "Status",
- "description": "The final status of the Span. This is optional."
- },
"name": {
"description": "Name of the span. The span name is sanitized and displayed in the\nStackdriver Trace tool in the {% 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"
@@ -333,11 +542,11 @@
}
},
"attributes": {
- "type": "object",
"additionalProperties": {
"$ref": "AttributeValue"
},
- "description": "Properties of a span. Attributes at the span level.\nE.g.\n\"/instance_id\": \"my-instance\"\n\"/zone\": \"us-central1-a\"\n\"/grpc/peer_address\": \"ip:port\" (dns, etc.)\n\"/grpc/deadline\": \"Duration\"\n\"/http/user_agent\"\n\"/http/request_bytes\": 300\n\"/http/response_bytes\": 1200\n\"/http/url\": google.com/apis\n\"/pid\"\n\"abc.com/myattribute\": \"my attribute value\"\n\nMaximum length for attribute key is 128 characters, for string attribute\nvalue is 2K characters."
+ "description": "Properties of a span. Attributes at the span level.\nE.g.\n\"/instance_id\": \"my-instance\"\n\"/zone\": \"us-central1-a\"\n\"/grpc/peer_address\": \"ip:port\" (dns, etc.)\n\"/grpc/deadline\": \"Duration\"\n\"/http/user_agent\"\n\"/http/request_bytes\": 300\n\"/http/response_bytes\": 1200\n\"/http/url\": google.com/apis\n\"/pid\"\n\"abc.com/myattribute\": \"my attribute value\"\n\nMaximum length for attribute key is 128 characters, for string attribute\nvalue is 2K characters.",
+ "type": "object"
},
"id": {
"description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.",
@@ -348,6 +557,31 @@
"description": "Local machine clock time from the UNIX epoch,\nat which span execution started.\nOn the server side these are the times when the server application\nhandler starts running.",
"format": "google-datetime",
"type": "string"
+ },
+ "hasRemoteParent": {
+ "description": "True if this Span has a remote parent (is an RPC server Span).",
+ "type": "boolean"
+ },
+ "localEndTime": {
+ "description": "Local machine clock time from the UNIX epoch,\nat which span execution ended.\nOn the server side these are the times when the server application\nhandler finishes running.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "parentId": {
+ "type": "string",
+ "description": "ID of parent span. 0 or missing if this is a root span.",
+ "format": "uint64"
+ },
+ "timeEvents": {
+ "description": "A collection of time-stamped events.",
+ "type": "array",
+ "items": {
+ "$ref": "TimeEvent"
+ }
+ },
+ "status": {
+ "$ref": "Status",
+ "description": "The final status of the Span. This is optional."
}
},
"id": "Span"
@@ -370,283 +604,49 @@
},
"id": "ListTracesResponse"
},
- "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"
+ "AttributeValue": {
+ "description": "Allowed attribute values.",
+ "type": "object",
+ "properties": {
+ "intValue": {
+ "description": "An integer value.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringValue": {
+ "description": "A string value.",
+ "type": "string"
+ },
+ "boolValue": {
+ "description": "A boolean value.",
+ "type": "boolean"
+ }
+ },
+ "id": "AttributeValue"
}
},
+ "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": "Tracing",
"auth": {
"oauth2": {
"scopes": {
- "https://www.googleapis.com/auth/trace.readonly": {
- "description": "Read Trace data for a project or application"
- },
"https://www.googleapis.com/auth/trace.append": {
"description": "Write Trace data for a project or application"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
+ },
+ "https://www.googleapis.com/auth/trace.readonly": {
+ "description": "Read Trace data for a project or application"
}
}
}
},
"rootUrl": "https://tracing.googleapis.com/",
"ownerDomain": "google.com",
- "name": "tracing",
- "batchPath": "batch",
- "title": "Google Tracing API",
- "ownerName": "Google",
- "resources": {
- "projects": {
- "resources": {
- "traces": {
- "methods": {
- "batchUpdate": {
- "id": "tracing.projects.traces.batchUpdate",
- "path": "v1/{+parent}/traces:batchUpdate",
- "request": {
- "$ref": "BatchUpdateSpansRequest"
- },
- "description": "Sends new spans to Stackdriver Trace or updates existing spans. If the\nname of 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\nname does not match, a new trace is created with given set of spans.",
- "httpMethod": "POST",
- "parameterOrder": [
- "parent"
- ],
- "response": {
- "$ref": "Empty"
- },
- "parameters": {
- "parent": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.append"
- ],
- "flatPath": "v1/projects/{projectsId}/traces:batchUpdate"
- },
- "listSpans": {
- "description": "Returns a list of spans within a trace.",
- "httpMethod": "GET",
- "parameterOrder": [
- "name"
- ],
- "response": {
- "$ref": "ListSpansResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "name": {
- "description": "ID of the span set where is \"projects/\u003cproject_id\u003e/traces/\u003ctrace_id\u003e\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/traces/[^/]+$",
- "location": "path"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `page_token` field from a previous request. Optional.",
- "type": "string"
- }
- },
- "flatPath": "v1/projects/{projectsId}/traces/{tracesId}:listSpans",
- "id": "tracing.projects.traces.listSpans",
- "path": "v1/{+name}:listSpans"
- },
- "list": {
- "flatPath": "v1/projects/{projectsId}/traces",
- "path": "v1/{+parent}/traces",
- "id": "tracing.projects.traces.list",
- "description": "Returns of a list of traces that match the specified filter conditions.",
- "response": {
- "$ref": "ListTracesResponse"
- },
- "parameterOrder": [
- "parent"
- ],
- "httpMethod": "GET",
- "parameters": {
- "endTime": {
- "location": "query",
- "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "location": "query",
- "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.",
- "format": "google-datetime",
- "type": "string"
- },
- "pageToken": {
- "location": "query",
- "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.",
- "type": "string"
- },
- "pageSize": {
- "location": "query",
- "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.",
- "format": "int32",
- "type": "integer"
- },
- "parent": {
- "location": "path",
- "description": "ID of the Cloud project where the trace data is stored.",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+$"
- },
- "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"
- },
- "filter": {
- "description": "An optional filter for the request.\nExample:\n\"version_label_key:a some_label:some_label_key\"\nreturns traces from version a and has some_label with some_label_key.",
- "type": "string",
- "location": "query"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ]
- },
- "get": {
- "httpMethod": "GET",
- "response": {
- "$ref": "Trace"
- },
- "parameterOrder": [
- "name"
- ],
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/trace.readonly"
- ],
- "parameters": {
- "name": {
- "location": "path",
- "description": "ID of the trace which is \"projects/\u003cproject_id\u003e/traces/\u003ctrace_id\u003e\".",
- "required": true,
- "type": "string",
- "pattern": "^projects/[^/]+/traces/[^/]+$"
- }
- },
- "flatPath": "v1/projects/{projectsId}/traces/{tracesId}",
- "id": "tracing.projects.traces.get",
- "path": "v1/{+name}",
- "description": "Returns a specific trace."
- }
- }
- }
- }
- }
- },
- "parameters": {
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
- "uploadType": {
- "type": "string",
- "location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
- },
- "$.xgafv": {
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "enum": [
- "1",
- "2"
- ],
- "description": "V1 error format.",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
- "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": {
- "description": "Pretty-print response.",
- "type": "boolean",
- "default": "true",
- "location": "query"
- },
- "oauth_token": {
- "location": "query",
- "description": "OAuth 2.0 token for the current user.",
- "type": "string"
- },
- "bearer_token": {
- "description": "OAuth bearer token.",
- "type": "string",
- "location": "query"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
- },
- "prettyPrint": {
- "location": "query",
- "description": "Returns response with indentations and line breaks.",
- "type": "boolean",
- "default": "true"
- }
- },
- "version": "v1",
- "baseUrl": "https://tracing.googleapis.com/"
+ "name": "tracing"
}
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json
index 7a5127d..a021550 100644
--- a/vision/v1/vision-api.json
+++ b/vision/v1/vision-api.json
@@ -1,25 +1,21 @@
{
- "ownerDomain": "google.com",
- "name": "vision",
- "batchPath": "batch",
- "title": "Google Cloud Vision API",
"ownerName": "Google",
"resources": {
"images": {
"methods": {
"annotate": {
+ "httpMethod": "POST",
+ "parameterOrder": [],
"response": {
"$ref": "BatchAnnotateImagesResponse"
},
- "parameterOrder": [],
- "httpMethod": "POST",
"parameters": {},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/images:annotate",
- "path": "v1/images:annotate",
"id": "vision.images.annotate",
+ "path": "v1/images:annotate",
"request": {
"$ref": "BatchAnnotateImagesRequest"
},
@@ -30,32 +26,34 @@
},
"parameters": {
"upload_protocol": {
- "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string"
+ "type": "string",
+ "location": "query"
},
"prettyPrint": {
- "location": "query",
"description": "Returns response with indentations and line breaks.",
"type": "boolean",
- "default": "true"
+ "default": "true",
+ "location": "query"
+ },
+ "uploadType": {
+ "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": {
+ "callback": {
"location": "query",
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "description": "JSONP",
"type": "string"
},
- "callback": {
- "description": "JSONP",
- "type": "string",
- "location": "query"
- },
"$.xgafv": {
+ "description": "V1 error format.",
+ "type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
@@ -64,17 +62,9 @@
"enum": [
"1",
"2"
- ],
- "description": "V1 error format.",
- "type": "string"
+ ]
},
"alt": {
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
@@ -82,22 +72,28 @@
],
"location": "query",
"description": "Data format for response.",
- "default": "json"
+ "default": "json",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "type": "string"
},
"access_token": {
+ "location": "query",
"description": "OAuth access token.",
+ "type": "string"
+ },
+ "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"
},
- "key": {
- "location": "query",
- "description": "API key. Your API 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",
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
+ "location": "query"
},
"pp": {
"location": "query",
@@ -111,9 +107,9 @@
"type": "string"
},
"oauth_token": {
- "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string"
+ "type": "string",
+ "location": "query"
}
},
"version": "v1",
@@ -122,130 +118,27 @@
"description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.",
"servicePath": "",
"basePath": "",
- "id": "vision:v1",
"documentationLink": "https://cloud.google.com/vision/",
"revision": "20170301",
+ "id": "vision:v1",
"discoveryVersion": "v1",
"version_module": "True",
"schemas": {
- "SafeSearchAnnotation": {
- "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).",
+ "DetectedLanguage": {
+ "description": "Detected language for a structural component.",
"type": "object",
"properties": {
- "medical": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Likelihood that this is a medical image.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ]
- },
- "violence": {
- "description": "Violence likelihood.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
- },
- "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.",
+ "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"
},
- "spoof": {
- "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
- "type": "string",
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ]
+ "confidence": {
+ "description": "Confidence of detected language. Range [0, 1].",
+ "format": "float",
+ "type": "number"
}
},
- "id": "SafeSearchAnnotation"
- },
- "DominantColorsAnnotation": {
- "description": "Set of dominant colors and their corresponding scores.",
- "type": "object",
- "properties": {
- "colors": {
- "description": "RGB color values with their score and pixel fraction.",
- "type": "array",
- "items": {
- "$ref": "ColorInfo"
- }
- }
- },
- "id": "DominantColorsAnnotation"
- },
- "TextAnnotation": {
- "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\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.",
- "type": "array",
- "items": {
- "$ref": "Page"
- }
- },
- "text": {
- "type": "string",
- "description": "UTF-8 text detected on the pages."
- }
- },
- "id": "TextAnnotation"
+ "id": "DetectedLanguage"
},
"Vertex": {
"description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.",
@@ -264,40 +157,6 @@
},
"id": "Vertex"
},
- "DetectedLanguage": {
- "id": "DetectedLanguage",
- "description": "Detected language for a structural component.",
- "type": "object",
- "properties": {
- "confidence": {
- "description": "Confidence of detected language. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "languageCode": {
- "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"
- }
- }
- },
- "TextProperty": {
- "type": "object",
- "properties": {
- "detectedLanguages": {
- "description": "A list of detected languages together with confidence.",
- "type": "array",
- "items": {
- "$ref": "DetectedLanguage"
- }
- },
- "detectedBreak": {
- "$ref": "DetectedBreak",
- "description": "Detected start or end of a text segment."
- }
- },
- "id": "TextProperty",
- "description": "Additional information detected on the structural component."
- },
"WebEntity": {
"description": "Entity deduced from similar images on the Internet.",
"type": "object",
@@ -319,6 +178,8 @@
"id": "WebEntity"
},
"BoundingPoly": {
+ "description": "A bounding polygon for the detected image annotation.",
+ "type": "object",
"properties": {
"vertices": {
"description": "The bounding polygon vertices.",
@@ -328,28 +189,33 @@
}
}
},
- "id": "BoundingPoly",
- "description": "A bounding polygon for the detected image annotation.",
- "type": "object"
+ "id": "BoundingPoly"
+ },
+ "TextProperty": {
+ "description": "Additional information detected on the structural component.",
+ "type": "object",
+ "properties": {
+ "detectedLanguages": {
+ "description": "A list of detected languages together with confidence.",
+ "type": "array",
+ "items": {
+ "$ref": "DetectedLanguage"
+ }
+ },
+ "detectedBreak": {
+ "description": "Detected start or end of a text segment.",
+ "$ref": "DetectedBreak"
+ }
+ },
+ "id": "TextProperty"
},
"AnnotateImageResponse": {
"description": "Response to an image annotation request.",
"type": "object",
"properties": {
- "safeSearchAnnotation": {
- "$ref": "SafeSearchAnnotation",
- "description": "If present, safe-search annotation has completed successfully."
- },
- "labelAnnotations": {
- "description": "If present, label detection has completed successfully.",
- "type": "array",
- "items": {
- "$ref": "EntityAnnotation"
- }
- },
"error": {
- "$ref": "Status",
- "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set."
+ "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set.",
+ "$ref": "Status"
},
"fullTextAnnotation": {
"$ref": "TextAnnotation",
@@ -388,12 +254,23 @@
}
},
"webDetection": {
- "$ref": "WebDetection",
- "description": "If present, web detection has completed successfully."
+ "description": "If present, web detection has completed successfully.",
+ "$ref": "WebDetection"
},
"cropHintsAnnotation": {
- "$ref": "CropHintsAnnotation",
- "description": "If present, crop hints have completed successfully."
+ "description": "If present, crop hints have completed successfully.",
+ "$ref": "CropHintsAnnotation"
+ },
+ "labelAnnotations": {
+ "description": "If present, label detection has completed successfully.",
+ "type": "array",
+ "items": {
+ "$ref": "EntityAnnotation"
+ }
+ },
+ "safeSearchAnnotation": {
+ "description": "If present, safe-search annotation has completed successfully.",
+ "$ref": "SafeSearchAnnotation"
}
},
"id": "AnnotateImageResponse"
@@ -422,14 +299,6 @@
"description": "Additional information detected for the block."
},
"blockType": {
- "enum": [
- "UNKNOWN",
- "TEXT",
- "TABLE",
- "PICTURE",
- "RULER",
- "BARCODE"
- ],
"description": "Detected block type (text, image etc) for this block.",
"type": "string",
"enumDescriptions": [
@@ -439,11 +308,19 @@
"Image block.",
"Horizontal/vertical line box.",
"Barcode block."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "TEXT",
+ "TABLE",
+ "PICTURE",
+ "RULER",
+ "BARCODE"
]
},
"boundingBox": {
- "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
+ "$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).",
@@ -455,10 +332,70 @@
},
"id": "Block"
},
+ "Property": {
+ "description": "A `Property` consists of a user-supplied name/value pair.",
+ "type": "object",
+ "properties": {
+ "uint64Value": {
+ "description": "Value of numeric properties.",
+ "format": "uint64",
+ "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": {
+ "$ref": "LatLng",
+ "description": "lat/long location coordinates."
+ }
+ },
+ "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"
+ },
"WebDetection": {
"description": "Relevant information for the image from the Internet.",
"type": "object",
"properties": {
+ "pagesWithMatchingImages": {
+ "description": "Web pages containing the matching images from the Internet.",
+ "type": "array",
+ "items": {
+ "$ref": "WebPage"
+ }
+ },
+ "partialMatchingImages": {
+ "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.",
+ "type": "array",
+ "items": {
+ "$ref": "WebImage"
+ }
+ },
"fullMatchingImages": {
"description": "Fully matching images from the Internet.\nThey're definite neardups and most often a copy of the query image with\nmerely a size change.",
"type": "array",
@@ -472,20 +409,6 @@
"items": {
"$ref": "WebEntity"
}
- },
- "pagesWithMatchingImages": {
- "description": "Web pages containing the matching images from the Internet.",
- "type": "array",
- "items": {
- "$ref": "WebPage"
- }
- },
- "partialMatchingImages": {
- "type": "array",
- "items": {
- "$ref": "WebImage"
- },
- "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops."
}
},
"id": "WebDetection"
@@ -504,56 +427,15 @@
},
"id": "BatchAnnotateImagesResponse"
},
- "ImageSource": {
- "id": "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"
- }
- }
- },
- "LocationInfo": {
- "description": "Detected entity location information.",
- "type": "object",
- "properties": {
- "latLng": {
- "$ref": "LatLng",
- "description": "lat/long location coordinates."
- }
- },
- "id": "LocationInfo"
- },
- "Property": {
- "description": "A `Property` consists of a user-supplied name/value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the property.",
- "type": "string"
- },
- "value": {
- "description": "Value of the property.",
- "type": "string"
- },
- "uint64Value": {
- "description": "Value of numeric properties.",
- "format": "uint64",
- "type": "string"
- }
- },
- "id": "Property"
- },
"Position": {
"description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.",
"type": "object",
"properties": {
+ "y": {
+ "description": "Y coordinate.",
+ "format": "float",
+ "type": "number"
+ },
"x": {
"description": "X coordinate.",
"format": "float",
@@ -563,11 +445,6 @@
"description": "Z coordinate (or depth).",
"format": "float",
"type": "number"
- },
- "y": {
- "description": "Y coordinate.",
- "format": "float",
- "type": "number"
}
},
"id": "Position"
@@ -576,14 +453,14 @@
"description": "Metadata for web pages.",
"type": "object",
"properties": {
- "url": {
- "description": "The result web page URL.",
- "type": "string"
- },
"score": {
"description": "Overall relevancy score for the web page.\nNot normalized and not comparable across different image queries.",
"format": "float",
"type": "number"
+ },
+ "url": {
+ "description": "The result web page URL.",
+ "type": "string"
}
},
"id": "WebPage"
@@ -592,10 +469,6 @@
"description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.",
"type": "object",
"properties": {
- "color": {
- "description": "RGB components of the color.",
- "$ref": "Color"
- },
"score": {
"description": "Image-specific score for this color. Value in range [0, 1].",
"format": "float",
@@ -605,44 +478,18 @@
"description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].",
"format": "float",
"type": "number"
+ },
+ "color": {
+ "$ref": "Color",
+ "description": "RGB components of the color."
}
},
"id": "ColorInfo"
},
"EntityAnnotation": {
- "id": "EntityAnnotation",
"description": "Set of detected entity features.",
"type": "object",
"properties": {
- "confidence": {
- "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
- "format": "float",
- "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. Currently not produced\nfor `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s\nare produced for the entire text detected in an image region, followed by\n`boundingPoly`s for each word within the detected text."
- },
- "description": {
- "description": "Entity textual description, expressed in its `locale` language.",
- "type": "string"
- },
- "topicality": {
- "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "properties": {
- "type": "array",
- "items": {
- "$ref": "Property"
- },
- "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity."
- },
"score": {
"description": "Overall score of the result. Range [0, 1].",
"format": "float",
@@ -658,8 +505,38 @@
"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"
+ },
+ "confidence": {
+ "description": "The accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "boundingPoly": {
+ "$ref": "BoundingPoly",
+ "description": "Image region to which this entity belongs. Currently not produced\nfor `LABEL_DETECTION` features. For `TEXT_DETECTION` (OCR), `boundingPoly`s\nare produced for the entire text detected in an image region, followed by\n`boundingPoly`s for each word within the detected text."
+ },
+ "locale": {
+ "description": "The language code for the locale in which the entity textual\n`description` is expressed.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Entity textual description, expressed in its `locale` language.",
+ "type": "string"
+ },
+ "topicality": {
+ "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "properties": {
+ "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.",
+ "type": "array",
+ "items": {
+ "$ref": "Property"
+ }
}
- }
+ },
+ "id": "EntityAnnotation"
},
"CropHint": {
"description": "Single crop hint that is used to generate a new crop when serving an image.",
@@ -676,22 +553,21 @@
"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"
},
"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": {
"position": {
- "description": "Face landmark position.",
- "$ref": "Position"
+ "$ref": "Position",
+ "description": "Face landmark position."
},
"type": {
- "description": "Face landmark type.",
- "type": "string",
"enumDescriptions": [
"Unknown face landmark detected. Should not be filled.",
"Left eye.",
@@ -765,27 +641,28 @@
"CHIN_GNATHION",
"CHIN_LEFT_GONION",
"CHIN_RIGHT_GONION"
- ]
+ ],
+ "description": "Face landmark type.",
+ "type": "string"
}
},
- "id": "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`."
+ "id": "Landmark"
},
"WebImage": {
+ "description": "Metadata for online images.",
+ "type": "object",
"properties": {
- "url": {
- "description": "The result image URL.",
- "type": "string"
- },
"score": {
"description": "Overall relevancy score for the image.\nNot normalized and not comparable across different image queries.",
"format": "float",
"type": "number"
+ },
+ "url": {
+ "description": "The result image URL.",
+ "type": "string"
}
},
- "id": "WebImage",
- "description": "Metadata for online images.",
- "type": "object"
+ "id": "WebImage"
},
"Word": {
"description": "A word representation.",
@@ -810,6 +687,8 @@
"id": "Word"
},
"Image": {
+ "description": "Client image to perform Google Cloud Vision API tasks over.",
+ "type": "object",
"properties": {
"content": {
"description": "Image content, represented as a stream of bytes.\nNote: as with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.",
@@ -821,28 +700,26 @@
"description": "Google Cloud Storage image location. If both `content` and `source`\nare provided for an image, `content` takes precedence and is\nused to perform the image annotation request."
}
},
- "id": "Image",
- "description": "Client image to perform Google Cloud Vision API tasks over.",
- "type": "object"
+ "id": "Image"
},
"Paragraph": {
"description": "Structural unit of text representing a number of words in certain order.",
"type": "object",
"properties": {
+ "property": {
+ "description": "Additional information detected for the paragraph.",
+ "$ref": "TextProperty"
+ },
"boundingBox": {
"$ref": "BoundingPoly",
"description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)."
},
"words": {
+ "description": "List of words in this paragraph.",
"type": "array",
"items": {
"$ref": "Word"
- },
- "description": "List of words in this paragraph."
- },
- "property": {
- "description": "Additional information detected for the paragraph.",
- "$ref": "TextProperty"
+ }
}
},
"id": "Paragraph"
@@ -851,46 +728,16 @@
"description": "A face annotation object contains the results of face detection.",
"type": "object",
"properties": {
+ "tiltAngle": {
+ "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
+ "format": "float",
+ "type": "number"
+ },
"fdBoundingPoly": {
- "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix.",
- "$ref": "BoundingPoly"
- },
- "angerLikelihood": {
- "enumDescriptions": [
- "Unknown likelihood.",
- "It is very unlikely that the image belongs to the specified vertical.",
- "It is unlikely that the image belongs to the specified vertical.",
- "It is possible that the image belongs to the specified vertical.",
- "It is likely that the image belongs to the specified vertical.",
- "It is very likely that the image belongs to the specified vertical."
- ],
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
- "description": "Anger likelihood.",
- "type": "string"
- },
- "landmarks": {
- "description": "Detected face landmarks.",
- "type": "array",
- "items": {
- "$ref": "Landmark"
- }
+ "$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": [
@@ -900,9 +747,26 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
},
- "joyLikelihood": {
+ "landmarks": {
+ "description": "Detected face landmarks.",
+ "type": "array",
+ "items": {
+ "$ref": "Landmark"
+ }
+ },
+ "angerLikelihood": {
+ "description": "Anger likelihood.",
+ "type": "string",
"enumDescriptions": [
"Unknown likelihood.",
"It is very unlikely that the image belongs to the specified vertical.",
@@ -918,26 +782,19 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
+ ]
+ },
+ "joyLikelihood": {
"description": "Joy likelihood.",
- "type": "string"
- },
- "landmarkingConfidence": {
- "description": "Face landmarking confidence. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "detectionConfidence": {
- "description": "Detection confidence. Range [0, 1].",
- "format": "float",
- "type": "number"
- },
- "panAngle": {
- "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].",
- "format": "float",
- "type": "number"
- },
- "underExposedLikelihood": {
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
"enum": [
"UNKNOWN",
"VERY_UNLIKELY",
@@ -945,7 +802,14 @@
"POSSIBLE",
"LIKELY",
"VERY_LIKELY"
- ],
+ ]
+ },
+ "landmarkingConfidence": {
+ "description": "Face landmarking confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
+ "underExposedLikelihood": {
"description": "Under-exposed likelihood.",
"type": "string",
"enumDescriptions": [
@@ -955,8 +819,26 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
},
+ "panAngle": {
+ "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].",
+ "format": "float",
+ "type": "number"
+ },
+ "detectionConfidence": {
+ "description": "Detection confidence. Range [0, 1].",
+ "format": "float",
+ "type": "number"
+ },
"blurredLikelihood": {
"enumDescriptions": [
"Unknown likelihood.",
@@ -978,14 +860,6 @@
"type": "string"
},
"headwearLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Headwear likelihood.",
"type": "string",
"enumDescriptions": [
@@ -995,6 +869,14 @@
"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"
]
},
"boundingPoly": {
@@ -1007,14 +889,6 @@
"type": "number"
},
"sorrowLikelihood": {
- "enum": [
- "UNKNOWN",
- "VERY_UNLIKELY",
- "UNLIKELY",
- "POSSIBLE",
- "LIKELY",
- "VERY_LIKELY"
- ],
"description": "Sorrow likelihood.",
"type": "string",
"enumDescriptions": [
@@ -1024,12 +898,15 @@
"It is possible that the image belongs to the specified vertical.",
"It is likely that the image belongs to the specified vertical.",
"It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
]
- },
- "tiltAngle": {
- "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].",
- "format": "float",
- "type": "number"
}
},
"id": "FaceAnnotation"
@@ -1053,8 +930,6 @@
"type": "object",
"properties": {
"type": {
- "description": "Detected break type.",
- "type": "string",
"enumDescriptions": [
"Unknown break label type.",
"Regular space.",
@@ -1070,18 +945,25 @@
"EOL_SURE_SPACE",
"HYPHEN",
"LINE_BREAK"
- ]
+ ],
+ "description": "Detected break type.",
+ "type": "string"
},
"isPrefix": {
- "type": "boolean",
- "description": "True if break prepends the element."
+ "description": "True if break prepends the element.",
+ "type": "boolean"
}
},
"id": "DetectedBreak"
},
"ImageContext": {
+ "description": "Image context and/or feature-specific parameters.",
"type": "object",
"properties": {
+ "cropHintsParams": {
+ "$ref": "CropHintsParams",
+ "description": "Parameters for crop hints annotation request."
+ },
"languageHints": {
"description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).",
"type": "array",
@@ -1090,16 +972,11 @@
}
},
"latLongRect": {
- "$ref": "LatLongRect",
- "description": "lat/long rectangle that specifies the location of the image."
- },
- "cropHintsParams": {
- "description": "Parameters for crop hints annotation request.",
- "$ref": "CropHintsParams"
+ "description": "lat/long rectangle that specifies the location of the image.",
+ "$ref": "LatLongRect"
}
},
- "id": "ImageContext",
- "description": "Image context and/or feature-specific parameters."
+ "id": "ImageContext"
},
"Page": {
"description": "Detected page from OCR.",
@@ -1118,8 +995,8 @@
}
},
"property": {
- "description": "Additional information detected on the page.",
- "$ref": "TextProperty"
+ "$ref": "TextProperty",
+ "description": "Additional information detected on the page."
},
"height": {
"description": "Page height in pixels.",
@@ -1130,7 +1007,6 @@
"id": "Page"
},
"AnnotateImageRequest": {
- "id": "AnnotateImageRequest",
"description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.",
"type": "object",
"properties": {
@@ -1146,16 +1022,27 @@
}
},
"imageContext": {
- "$ref": "ImageContext",
- "description": "Additional context that may accompany the image."
+ "description": "Additional context that may accompany the image.",
+ "$ref": "ImageContext"
}
- }
+ },
+ "id": "AnnotateImageRequest"
},
"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` which can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting purpose.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. 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 will be a\ncommon set of message types for APIs to use.",
+ "type": "array",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ }
+ },
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
@@ -1164,35 +1051,25 @@
"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 will be a\ncommon set of message types for APIs to use.",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": {
- "description": "Properties of the object. Contains field @type with type URL.",
- "type": "any"
- }
- }
}
- }
+ },
+ "id": "Status"
},
"Symbol": {
"description": "A single symbol representation.",
"type": "object",
"properties": {
- "property": {
- "$ref": "TextProperty",
- "description": "Additional information detected for the symbol."
- },
- "boundingBox": {
- "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).",
- "$ref": "BoundingPoly"
- },
"text": {
"description": "The actual UTF-8 representation of the symbol.",
"type": "string"
+ },
+ "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)."
}
},
"id": "Symbol"
@@ -1202,17 +1079,19 @@
"type": "object",
"properties": {
"minLatLng": {
- "$ref": "LatLng",
- "description": "Min lat/long pair."
+ "description": "Min lat/long pair.",
+ "$ref": "LatLng"
},
"maxLatLng": {
- "$ref": "LatLng",
- "description": "Max lat/long pair."
+ "description": "Max 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.",
@@ -1222,21 +1101,19 @@
}
}
},
- "id": "CropHintsAnnotation",
- "description": "Set of crop hints that are used to generate new crops when serving images.",
- "type": "object"
+ "id": "CropHintsAnnotation"
},
"LatLng": {
"description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.\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)\n\nThe code in logs/storage/validator/logs_validator_traits.cc treats this type\nas if it were annotated as ST_LOCATION.",
"type": "object",
"properties": {
- "longitude": {
- "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
+ "latitude": {
+ "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
"format": "double",
"type": "number"
},
- "latitude": {
- "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].",
+ "longitude": {
+ "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].",
"format": "double",
"type": "number"
}
@@ -1244,6 +1121,7 @@
"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": {
@@ -1267,23 +1145,25 @@
"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 // ..."
+ "id": "Color"
},
"ImageProperties": {
"description": "Stores image properties, such as dominant colors.",
"type": "object",
"properties": {
"dominantColors": {
- "description": "If present, dominant colors completed successfully.",
- "$ref": "DominantColorsAnnotation"
+ "$ref": "DominantColorsAnnotation",
+ "description": "If present, dominant colors completed successfully."
}
},
"id": "ImageProperties"
},
"Feature": {
+ "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
+ "type": "object",
"properties": {
"type": {
+ "description": "The feature type.",
"type": "string",
"enumDescriptions": [
"Unspecified feature type.",
@@ -1310,8 +1190,7 @@
"IMAGE_PROPERTIES",
"CROP_HINTS",
"WEB_DETECTION"
- ],
- "description": "The feature type."
+ ]
},
"maxResults": {
"description": "Maximum number of results of this type.",
@@ -1319,14 +1198,131 @@
"type": "integer"
}
},
- "id": "Feature",
- "description": "Users describe the type of Google Cloud Vision API tasks to perform over\nimages by using *Feature*s. Each Feature indicates a type of image\ndetection task to perform. Features encode the Cloud Vision API\nvertical to operate on and the number of top-scoring results to return.",
- "type": "object"
+ "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": {
+ "medical": {
+ "description": "Likelihood that this is a medical image.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ },
+ "violence": {
+ "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": "Violence likelihood.",
+ "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.",
+ "type": "string"
+ },
+ "spoof": {
+ "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.",
+ "type": "string",
+ "enumDescriptions": [
+ "Unknown likelihood.",
+ "It is very unlikely that the image belongs to the specified vertical.",
+ "It is unlikely that the image belongs to the specified vertical.",
+ "It is possible that the image belongs to the specified vertical.",
+ "It is likely that the image belongs to the specified vertical.",
+ "It is very likely that the image belongs to the specified vertical."
+ ],
+ "enum": [
+ "UNKNOWN",
+ "VERY_UNLIKELY",
+ "UNLIKELY",
+ "POSSIBLE",
+ "LIKELY",
+ "VERY_LIKELY"
+ ]
+ }
+ },
+ "id": "SafeSearchAnnotation"
+ },
+ "DominantColorsAnnotation": {
+ "description": "Set of dominant colors and their corresponding scores.",
+ "type": "object",
+ "properties": {
+ "colors": {
+ "description": "RGB color values with their score and pixel fraction.",
+ "type": "array",
+ "items": {
+ "$ref": "ColorInfo"
+ }
+ }
+ },
+ "id": "DominantColorsAnnotation"
+ },
+ "TextAnnotation": {
+ "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please\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.",
+ "type": "array",
+ "items": {
+ "$ref": "Page"
+ }
+ },
+ "text": {
+ "description": "UTF-8 text detected on the pages.",
+ "type": "string"
+ }
+ },
+ "id": "TextAnnotation"
}
},
"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": "Vision",
@@ -1339,5 +1335,9 @@
}
}
},
- "rootUrl": "https://vision.googleapis.com/"
+ "rootUrl": "https://vision.googleapis.com/",
+ "ownerDomain": "google.com",
+ "name": "vision",
+ "batchPath": "batch",
+ "title": "Google Cloud Vision API"
}
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json
index 7538c8f..d31eab0 100644
--- a/youtubereporting/v1/youtubereporting-api.json
+++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,74 +1,61 @@
{
+ "canonicalName": "YouTube Reporting",
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/yt-analytics.readonly": {
+ "description": "View YouTube Analytics reports for your YouTube content"
+ },
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
+ "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
+ }
+ }
+ }
+ },
+ "kind": "discovery#restDescription",
+ "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.",
+ "servicePath": "",
"rootUrl": "https://youtubereporting.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "youtubereporting",
"batchPath": "batch",
- "revision": "20170304",
- "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
"id": "youtubereporting:v1",
+ "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/",
+ "revision": "20170308",
"title": "YouTube Reporting API",
"ownerName": "Google",
"discoveryVersion": "v1",
"resources": {
- "media": {
- "methods": {
- "download": {
- "flatPath": "v1/media/{mediaId}",
- "path": "v1/media/{+resourceName}",
- "id": "youtubereporting.media.download",
- "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
- "supportsMediaDownload": true,
- "response": {
- "$ref": "Media"
- },
- "parameterOrder": [
- "resourceName"
- ],
- "httpMethod": "GET",
- "parameters": {
- "resourceName": {
- "location": "path",
- "description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
- "required": true,
- "type": "string",
- "pattern": "^.+$"
- }
- },
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ]
- }
- }
- },
"jobs": {
"resources": {
"reports": {
"methods": {
"list": {
- "response": {
- "$ref": "ListReportsResponse"
- },
+ "httpMethod": "GET",
"parameterOrder": [
"jobId"
],
- "httpMethod": "GET",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
"parameters": {
"jobId": {
- "required": true,
- "type": "string",
"location": "path",
- "description": "The ID of the job."
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string"
},
"createdAfter": {
- "location": "query",
"description": "If set, only reports created after the specified date/time are returned.",
"format": "google-datetime",
+ "type": "string",
+ "location": "query"
+ },
+ "startTimeAtOrAfter": {
+ "location": "query",
+ "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
+ "format": "google-datetime",
"type": "string"
},
"pageToken": {
@@ -76,12 +63,6 @@
"description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.",
"type": "string"
},
- "startTimeAtOrAfter": {
- "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.",
- "format": "google-datetime",
- "type": "string",
- "location": "query"
- },
"pageSize": {
"description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
"format": "int32",
@@ -100,12 +81,17 @@
"location": "query"
}
},
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"flatPath": "v1/jobs/{jobId}/reports",
- "path": "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."
},
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "Report"
},
@@ -113,100 +99,81 @@
"jobId",
"reportId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"parameters": {
"onBehalfOfContentOwner": {
+ "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
"type": "string",
- "location": "query",
- "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)."
+ "location": "query"
},
"reportId": {
- "location": "path",
"description": "The ID of the report to retrieve.",
"required": true,
- "type": "string"
- },
- "jobId": {
- "description": "The ID of the job.",
- "required": true,
"type": "string",
"location": "path"
+ },
+ "jobId": {
+ "location": "path",
+ "description": "The ID of the job.",
+ "required": true,
+ "type": "string"
}
},
"flatPath": "v1/jobs/{jobId}/reports/{reportId}",
- "path": "v1/jobs/{jobId}/reports/{reportId}",
"id": "youtubereporting.jobs.reports.get",
+ "path": "v1/jobs/{jobId}/reports/{reportId}",
"description": "Gets the metadata of a specific report."
}
}
}
},
"methods": {
- "create": {
- "description": "Creates a job and returns it.",
- "request": {
- "$ref": "Job"
- },
- "response": {
- "$ref": "Job"
- },
- "parameterOrder": [],
- "httpMethod": "POST",
- "scopes": [
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
- "https://www.googleapis.com/auth/yt-analytics.readonly"
- ],
- "parameters": {
- "onBehalfOfContentOwner": {
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string",
- "location": "query"
- }
- },
- "flatPath": "v1/jobs",
- "path": "v1/jobs",
- "id": "youtubereporting.jobs.create"
- },
"delete": {
- "id": "youtubereporting.jobs.delete",
- "path": "v1/jobs/{jobId}",
- "description": "Deletes a job.",
"httpMethod": "DELETE",
- "parameterOrder": [
- "jobId"
- ],
"response": {
"$ref": "Empty"
},
+ "parameterOrder": [
+ "jobId"
+ ],
"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"
+ },
"jobId": {
"description": "The ID of the job to delete.",
"required": true,
"type": "string",
"location": "path"
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
- "flatPath": "v1/jobs/{jobId}"
+ "flatPath": "v1/jobs/{jobId}",
+ "id": "youtubereporting.jobs.delete",
+ "path": "v1/jobs/{jobId}",
+ "description": "Deletes a job."
},
"list": {
+ "id": "youtubereporting.jobs.list",
+ "path": "v1/jobs",
+ "description": "Lists jobs.",
"httpMethod": "GET",
"response": {
"$ref": "ListJobsResponse"
},
"parameterOrder": [],
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
"parameters": {
"pageToken": {
"location": "query",
@@ -214,9 +181,9 @@
"type": "string"
},
"includeSystemManaged": {
- "type": "boolean",
"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."
+ "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"
},
"pageSize": {
"location": "query",
@@ -230,80 +197,98 @@
"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",
- "description": "Lists jobs."
+ "flatPath": "v1/jobs"
},
"get": {
+ "httpMethod": "GET",
"response": {
"$ref": "Job"
},
"parameterOrder": [
"jobId"
],
- "httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
"https://www.googleapis.com/auth/yt-analytics.readonly"
],
"parameters": {
+ "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": {
- "location": "path",
"description": "The ID of the job to retrieve.",
"required": true,
- "type": "string"
- },
- "onBehalfOfContentOwner": {
- "location": "query",
- "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).",
- "type": "string"
+ "type": "string",
+ "location": "path"
}
},
"flatPath": "v1/jobs/{jobId}",
- "path": "v1/jobs/{jobId}",
"id": "youtubereporting.jobs.get",
+ "path": "v1/jobs/{jobId}",
"description": "Gets a job."
+ },
+ "create": {
+ "id": "youtubereporting.jobs.create",
+ "path": "v1/jobs",
+ "request": {
+ "$ref": "Job"
+ },
+ "description": "Creates a job and returns it.",
+ "httpMethod": "POST",
+ "parameterOrder": [],
+ "response": {
+ "$ref": "Job"
+ },
+ "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"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "flatPath": "v1/jobs"
}
}
},
"reportTypes": {
"methods": {
"list": {
+ "parameterOrder": [],
+ "httpMethod": "GET",
"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": {
- "pageSize": {
- "type": "integer",
- "location": "query",
- "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
- "format": "int32"
- },
- "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).",
+ "pageToken": {
+ "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
"type": "string",
"location": "query"
},
- "pageToken": {
- "location": "query",
- "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.",
- "type": "string"
- },
"includeSystemManaged": {
+ "location": "query",
"description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.",
- "type": "boolean",
+ "type": "boolean"
+ },
+ "pageSize": {
+ "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.",
+ "format": "int32",
+ "type": "integer",
"location": "query"
+ },
+ "onBehalfOfContentOwner": {
+ "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/reportTypes",
@@ -312,14 +297,55 @@
"description": "Lists report types."
}
}
+ },
+ "media": {
+ "methods": {
+ "download": {
+ "response": {
+ "$ref": "Media"
+ },
+ "parameterOrder": [
+ "resourceName"
+ ],
+ "httpMethod": "GET",
+ "parameters": {
+ "resourceName": {
+ "pattern": "^.+$",
+ "location": "path",
+ "description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly",
+ "https://www.googleapis.com/auth/yt-analytics.readonly"
+ ],
+ "flatPath": "v1/media/{mediaId}",
+ "path": "v1/media/{+resourceName}",
+ "id": "youtubereporting.media.download",
+ "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.",
+ "supportsMediaDownload": true
+ }
+ }
}
},
"parameters": {
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "access_token": {
+ "description": "OAuth access token.",
"type": "string",
"location": "query"
},
+ "key": {
+ "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+ "type": "string",
+ "location": "query"
+ },
+ "quotaUser": {
+ "location": "query",
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "type": "string"
+ },
"pp": {
"description": "Pretty-print response.",
"type": "boolean",
@@ -332,14 +358,14 @@
"location": "query"
},
"oauth_token": {
+ "location": "query",
"description": "OAuth 2.0 token for the current user.",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"upload_protocol": {
+ "location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "type": "string",
- "location": "query"
+ "type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
@@ -347,37 +373,35 @@
"default": "true",
"location": "query"
},
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "type": "string",
- "location": "query"
- },
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "type": "string",
+ "location": "query"
+ },
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
- "type": "string",
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query"
+ "type": "string"
},
"alt": {
- "description": "Data format for response.",
- "default": "json",
"enum": [
"json",
"media",
@@ -389,24 +413,42 @@
"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"
+ "description": "Data format for response.",
+ "default": "json"
}
},
"schemas": {
+ "ListReportsResponse": {
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "reports": {
+ "description": "The list of report types.",
+ "type": "array",
+ "items": {
+ "$ref": "Report"
+ }
+ }
+ },
+ "id": "ListReportsResponse",
+ "description": "Response message for ReportingService.ListReports.",
+ "type": "object"
+ },
+ "Media": {
+ "properties": {
+ "resourceName": {
+ "description": "Name of the media resource.",
+ "type": "string"
+ }
+ },
+ "id": "Media",
+ "description": "Media resource.",
+ "type": "object"
+ },
"ReportType": {
- "id": "ReportType",
- "description": "A report type.",
- "type": "object",
"properties": {
"id": {
"description": "The ID of the report type (max. 100 characters).",
@@ -425,31 +467,10 @@
"description": "The name of the report type (max. 100 characters).",
"type": "string"
}
- }
- },
- "ListReportTypesResponse": {
- "description": "Response message for ReportingService.ListReportTypes.",
- "type": "object",
- "properties": {
- "reportTypes": {
- "description": "The list of report types.",
- "type": "array",
- "items": {
- "$ref": "ReportType"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
- "type": "string"
- }
},
- "id": "ListReportTypesResponse"
- },
- "Empty": {
- "id": "Empty",
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "type": "object",
- "properties": {}
+ "id": "ReportType",
+ "description": "A report type.",
+ "type": "object"
},
"Report": {
"description": "A report's metadata including the URL from which the report itself can be\ndownloaded.",
@@ -459,13 +480,13 @@
"description": "The server-generated ID of the report.",
"type": "string"
},
- "jobExpireTime": {
- "description": "The date/time when the job this report belongs to will expire/expired.",
+ "endTime": {
+ "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
"format": "google-datetime",
"type": "string"
},
- "endTime": {
- "description": "The end of the time period that the report instance covers. The value is\nexclusive.",
+ "jobExpireTime": {
+ "description": "The date/time when the job this report belongs to will expire/expired.",
"format": "google-datetime",
"type": "string"
},
@@ -490,6 +511,30 @@
},
"id": "Report"
},
+ "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"
+ },
+ "ListReportTypesResponse": {
+ "description": "Response message for ReportingService.ListReportTypes.",
+ "type": "object",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.",
+ "type": "string"
+ },
+ "reportTypes": {
+ "description": "The list of report types.",
+ "type": "array",
+ "items": {
+ "$ref": "ReportType"
+ }
+ }
+ },
+ "id": "ListReportTypesResponse"
+ },
"ListJobsResponse": {
"description": "Response message for ReportingService.ListJobs.",
"type": "object",
@@ -512,14 +557,6 @@
"description": "A job creating reports of a specific type.",
"type": "object",
"properties": {
- "systemManaged": {
- "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
- "type": "boolean"
- },
- "id": {
- "description": "The server-generated ID of the job (max. 40 characters).",
- "type": "string"
- },
"createTime": {
"description": "The creation date/time of the job.",
"format": "google-datetime",
@@ -537,61 +574,24 @@
"name": {
"description": "The name of the job (max. 100 characters).",
"type": "string"
+ },
+ "id": {
+ "description": "The server-generated ID of the job (max. 40 characters).",
+ "type": "string"
+ },
+ "systemManaged": {
+ "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.",
+ "type": "boolean"
}
},
"id": "Job"
- },
- "ListReportsResponse": {
- "description": "Response message for ReportingService.ListReports.",
- "type": "object",
- "properties": {
- "reports": {
- "description": "The list of report types.",
- "type": "array",
- "items": {
- "$ref": "Report"
- }
- },
- "nextPageToken": {
- "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.",
- "type": "string"
- }
- },
- "id": "ListReportsResponse"
- },
- "Media": {
- "description": "Media resource.",
- "type": "object",
- "properties": {
- "resourceName": {
- "description": "Name of the media resource.",
- "type": "string"
- }
- },
- "id": "Media"
}
},
"icons": {
- "x32": "http://www.google.com/images/icons/product/search-32.gif",
- "x16": "http://www.google.com/images/icons/product/search-16.gif"
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"version": "v1",
- "baseUrl": "https://youtubereporting.googleapis.com/",
- "canonicalName": "YouTube Reporting",
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/yt-analytics-monetary.readonly": {
- "description": "View monetary and non-monetary YouTube Analytics reports for your YouTube content"
- },
- "https://www.googleapis.com/auth/yt-analytics.readonly": {
- "description": "View YouTube Analytics reports for your YouTube content"
- }
- }
- }
- },
- "servicePath": "",
- "kind": "discovery#restDescription",
- "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files."
+ "baseUrl": "https://youtubereporting.googleapis.com/"
}
